diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 2ca09f5d3c036a..54f8cef6b864b1 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -97287,6 +97287,46 @@ declare namespace Word { 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; + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly bibliography: Word.Bibliography; + /** + * Returns a `TemplateCollection` object that represents all the available templates: global templates and those attached to open documents. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly templates: Word.TemplateCollection; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + checkLanguage: boolean; + /** + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly 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"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on 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.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Application): void; /** * Creates a new document by using an optional Base64-encoded .docx file. * @@ -97321,6 +97361,27 @@ declare namespace Word { * @param base64File Required. The template file. */ retrieveStylesFromBase64(base64File: 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.ApplicationLoadOptions): Word.Application; + /** + * Queues up a command to load the specified properties of the object. You must 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.Application; + /** + * 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.Application; /** * Create a new instance of the `Word.Application` object. */ @@ -97329,9 +97390,7 @@ declare namespace Word { * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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; - }; + toJSON(): Word.Interfaces.ApplicationData; } /** * Represents the body of a document or a section. @@ -97871,6 +97930,123 @@ declare namespace Word { */ toJSON(): Word.Interfaces.BorderData; } + /** + * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class BorderUniversal extends OfficeExtension.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 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"; + /** + * Returns `true` if an inside border can be applied to the specified object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly inside: boolean; + /** + * 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"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on 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.BorderUniversalUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.BorderUniversal): 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.BorderUniversalLoadOptions): Word.BorderUniversal; + /** + * Queues up a command to load the specified properties of the object. You must 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.BorderUniversal; + /** + * 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.BorderUniversal; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.BorderUniversal; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.BorderUniversal; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BorderUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BorderUniversalData; + } /** * Represents the collection of border styles. * @@ -97986,6 +98162,68 @@ declare namespace Word { */ toJSON(): Word.Interfaces.BorderCollectionData; } + /** + * Represents the collection of {@link Word.BorderUniversal} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class BorderUniversalCollection extends OfficeExtension.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.BorderUniversal[]; + /** + * Applies the specified page-border formatting to all sections in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyPageBordersToAllSections(): void; + /** + * Gets a `Border` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The location of a `BorderUniversal` object. + */ + getItem(index: number): Word.BorderUniversal; + /** + * Queues up a command to load the specified properties 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.BorderUniversalCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BorderUniversalCollection; + /** + * Queues up a command to load the specified properties of the object. You must 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.BorderUniversalCollection; + /** + * 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.BorderUniversalCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.BorderUniversalCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.BorderUniversalCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BorderUniversalCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.BorderUniversalCollectionData; + } /** * Represents a break in a Word document. This could be a page, column, or section break. * @@ -98100,172 +98338,118 @@ declare namespace Word { toJSON(): Word.Interfaces.BreakCollectionData; } /** - * The data specific to content controls of type CheckBox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - 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.7] - */ - isChecked: 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.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.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.CheckboxContentControl; - /** - * 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.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.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.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.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.CheckboxContentControlData; - } - /** - * Represents a comment in the document. + * 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 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class Comment extends OfficeExtension.ClientObject { + class BuildingBlock extends OfficeExtension.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. + * Returns a `BuildingBlockCategory` object that represents the category for the building block. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange: Word.CommentContentRange; + readonly category: Word.BuildingBlockCategory; /** - * Gets the collection of reply objects associated with the comment. + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly replies: Word.CommentReplyCollection; + readonly type: Word.BuildingBlockTypeItem; /** - * Gets the email of the comment's author. + * Specifies the description for the building block. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly authorEmail: string; + description: string; /** - * Gets the name of the comment's author. + * Returns the internal identification number for the building block. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly authorName: string; + readonly id: string; /** - * Specifies the comment's content as plain text. + * Returns the position of this building block in a collection. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content: string; + readonly index: number; /** - * Gets the creation date of the comment. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly creationDate: Date; + insertType: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; /** - * Gets the ID of the comment. + * Specifies the name of the building block. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly id: string; + name: 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. + * Specifies the contents of the building block. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved: boolean; + 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.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.BuildingBlockUpdateData, 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; + set(properties: Word.BuildingBlock): void; /** - * Deletes the comment and its replies. + * Deletes the building block. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ 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. + * Inserts the value of the building block into the document and returns a `Range` object that represents the contents of the building block within the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param replyText Required. Reply text. + * @param range The range where the building block should be inserted. + * @param richText Indicates whether to insert as rich text. */ - reply(replyText: string): Word.CommentReply; + insert(range: Word.Range, richText: boolean): 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.CommentLoadOptions): Word.Comment; + load(options?: Word.Interfaces.BuildingBlockLoadOptions): Word.BuildingBlock; /** * Queues up a command to load the specified properties of the object. You must 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; + load(propertyNames?: string | string[]): Word.BuildingBlock; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -98274,164 +98458,249 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Comment; + }): Word.BuildingBlock; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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; + track(): Word.BuildingBlock; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any 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; + untrack(): Word.BuildingBlock; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.BuildingBlock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CommentData; + toJSON(): Word.Interfaces.BuildingBlockData; } /** - * Contains a collection of {@link Word.Comment} objects. + * Represents a collection of {@link Word.BuildingBlock} objects for a specific building block type and category in a template. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class CommentCollection extends OfficeExtension.ClientObject { + class BuildingBlockCollection extends OfficeExtension.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. + * Creates a new building block and returns a `BuildingBlock` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The name of the building block. + * @param range The range to insert the building block. + * @param description The description of the building block. + * @param insertType How to insert the contents of the building block. */ - getFirst(): Word.Comment; + add(name: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType): Word.BuildingBlock; /** - * 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}. + * Creates a new building block and returns a `BuildingBlock` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The name of the building block. + * @param range The range to insert the building block. + * @param description The description of the building block. + * @param insertType How to insert the contents of the building block. */ - getFirstOrNullObject(): Word.Comment; + add(name: string, range: Word.Range, description: string, insertType: "Content" | "Paragraph" | "Page"): Word.BuildingBlock; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the number of items in the collection. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.CommentCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentCollection; + getCount(): OfficeExtension.ClientResult; + /** + * Returns a `BuildingBlock` 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. + */ + getItemAt(index: number): Word.BuildingBlock; /** * Queues up a command to load the specified properties of the object. You must 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; + load(propertyNames?: string | string[]): Word.BuildingBlockCollection; /** * 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; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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; + track(): Word.BuildingBlockCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any 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; + untrack(): Word.BuildingBlockCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.BuildingBlockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCollectionData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CommentCollectionData; + toJSON(): { + [key: string]: string; + }; } /** + * Represents a collection of building block entries in a Word template. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class CommentContentRange extends OfficeExtension.ClientObject { + class BuildingBlockEntryCollection extends OfficeExtension.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. + * Creates a new building block entry in a template and returns a `BuildingBlock` object that represents the new building block entry. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The name of the building block. + * @param type The type of the building block. + * @param category The category of the building block. + * @param range The range to insert the building block. + * @param description The description of the building block. + * @param insertType How to insert the contents of the building block. */ - bold: boolean; + add(name: string, type: Word.BuildingBlockType, category: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType): Word.BuildingBlock; /** - * 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. + * Creates a new building block entry in a template and returns a `BuildingBlock` object that represents the new building block entry. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The name of the building block. + * @param type The type of the building block. + * @param category The category of the building block. + * @param range The range to insert the building block. + * @param description The description of the building block. + * @param insertType How to insert the contents of the building block. */ - hyperlink: string; + add(name: string, type: "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", category: string, range: Word.Range, description: string, insertType: "Content" | "Paragraph" | "Page"): Word.BuildingBlock; /** - * Checks whether the range length is zero. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly isEmpty: boolean; + getCount(): OfficeExtension.ClientResult; /** - * Specifies a value that indicates whether the comment text is italicized. + * Returns a `BuildingBlock` object that represents the specified item in the collection. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The index of the item to retrieve. */ - italic: boolean; + getItemAt(index: number): Word.BuildingBlock; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * 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 propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - strikeThrough: boolean; + load(propertyNames?: string | string[]): Word.BuildingBlockEntryCollection; /** - * Gets the text of the comment 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.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. */ - readonly text: string; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockEntryCollection; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.BuildingBlockEntryCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.BuildingBlockEntryCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BuildingBlockEntryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockEntryCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents a category of building blocks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class BuildingBlockCategory extends OfficeExtension.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 `BuildingBlockCollection` object that represents the building blocks for the category. * * @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"; + readonly buildingBlocks: Word.BuildingBlockCollection; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on 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 `BuildingBlockTypeItem` object that represents the type of building block for the building block category. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + readonly type: Word.BuildingBlockTypeItem; /** - * 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. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly index: number; + /** + * Returns the name of the `BuildingBlockCategory` object. * - * @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'. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange; + 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.CommentContentRangeLoadOptions): Word.CommentContentRange; + load(options?: Word.Interfaces.BuildingBlockCategoryLoadOptions): Word.BuildingBlockCategory; /** * Queues up a command to load the specified properties of the object. You must 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; + load(propertyNames?: string | string[]): Word.BuildingBlockCategory; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -98440,285 +98709,254 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.CommentContentRange; + }): Word.BuildingBlockCategory; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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; + track(): Word.BuildingBlockCategory; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any 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; + untrack(): Word.BuildingBlockCategory; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.BuildingBlockCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CommentContentRangeData; + toJSON(): Word.Interfaces.BuildingBlockCategoryData; } /** - * Represents a comment reply in the document. + * Represents a collection of {@link Word.BuildingBlockCategory} objects in a Word document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class CommentReply extends OfficeExtension.ClientObject { + class BuildingBlockCategoryCollection extends OfficeExtension.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. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange: Word.CommentContentRange; + getCount(): OfficeExtension.ClientResult; /** - * Gets the parent comment of this reply. + * Returns a `BuildingBlockCategory` object that represents the specified item in the collection. * * @remarks - * [Api set: WordApi 1.4] - */ - readonly parentComment: Word.Comment; - /** - * Gets the email of the comment reply's author. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApi 1.4] + * @param index The index of the item to retrieve. */ - readonly authorEmail: string; + getItemAt(index: number): Word.BuildingBlockCategory; /** - * Gets the name of the comment reply's author. + * 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 propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly authorName: string; + load(propertyNames?: string | string[]): Word.BuildingBlockCategoryCollection; /** - * Specifies the comment reply's content. The string is plain text. + * 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] - */ - 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. + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a 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; + }): Word.BuildingBlockCategoryCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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; + track(): Word.BuildingBlockCategoryCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any 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; + untrack(): Word.BuildingBlockCategoryCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.BuildingBlockCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryCollectionData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CommentReplyData; + toJSON(): { + [key: string]: string; + }; } /** - * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. + * Represents a type of building block in a Word document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class CommentReplyCollection extends OfficeExtension.ClientObject { + class BuildingBlockTypeItem extends OfficeExtension.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. + * Returns a `BuildingBlockCategoryCollection` object that represents the categories for a building block type. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.CommentReply; + readonly categories: Word.BuildingBlockCategoryCollection; /** - * 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}. + * Returns the position of an item in a collection. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.CommentReply; + readonly index: number; + /** + * Returns the localized name of a building block type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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.CommentReplyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentReplyCollection; + load(options?: Word.Interfaces.BuildingBlockTypeItemLoadOptions): Word.BuildingBlockTypeItem; /** * Queues up a command to load the specified properties of the object. You must 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; + load(propertyNames?: string | string[]): Word.BuildingBlockTypeItem; /** * 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; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockTypeItem; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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; + track(): Word.BuildingBlockTypeItem; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any 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; + untrack(): Word.BuildingBlockTypeItem; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.BuildingBlockTypeItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CommentReplyCollectionData; + toJSON(): Word.Interfaces.BuildingBlockTypeItemData; } /** - * 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. + * Represents a collection of building block types in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class XmlMapping extends OfficeExtension.ClientObject { + class BuildingBlockTypeItemCollection extends OfficeExtension.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 `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Gets a `BuildingBlockTypeItem` object by its type in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param type Specifies the building block type of the item in the collection. */ - readonly customXmlNode: Word.CustomXmlNode; + getByType(type: Word.BuildingBlockType): Word.BuildingBlockTypeItem; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Gets a `BuildingBlockTypeItem` object by its type in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param type Specifies the building block type of the item in the collection. */ - readonly customXmlPart: Word.CustomXmlPart; + getByType(type: "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"): Word.BuildingBlockTypeItem; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isMapped: boolean; + getCount(): OfficeExtension.ClientResult; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * 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 prefixMappings: string; + load(propertyNames?: string | string[]): Word.BuildingBlockTypeItemCollection; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * 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 xpath: string; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockTypeItemCollection; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on 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.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.XmlMapping): void; + track(): Word.BuildingBlockTypeItemCollection; /** - * Deletes the XML mapping from the parent content control. - * - * @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. */ - delete(): void; + untrack(): Word.BuildingBlockTypeItemCollection; /** - * Allows creating or changing the XML mapping on the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param xPath The XPath expression to evaluate. - * @param options Optional. The options available for setting the XML mapping. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BuildingBlockTypeItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. */ - setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult; + toJSON(): { + [key: string]: string; + }; + } + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + 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; /** - * Allows creating or changing the XML data mapping on the content control. + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param node The custom XML node to map. + * [Api set: WordApi 1.7] */ - setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult; + isChecked: 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.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.XmlMappingLoadOptions): Word.XmlMapping; + 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.XmlMapping; + 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. * @@ -98727,254 +98965,295 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.XmlMapping; + }): 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.XmlMapping; + 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.XmlMapping; + 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.XmlMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlMappingData`) 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.XmlMappingData; + toJSON(): Word.Interfaces.CheckboxContentControlData; } /** - * The options that define the prefix mapping and the source of the custom XML data. + * Represents a comment in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - interface XmlSetMappingOptions { + 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; /** - * If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method. If omitted, Word uses the set of prefix mappings for the specified custom XML part in the current document. + * Specifies the comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - prefixMapping?: string; + contentRange: Word.CommentContentRange; /** - * If provided, specifies the desired custom XML data to map the content control to. If this property is omitted, the XPath is evaluated against all custom XML in the current document, and the mapping is established with the first `CustomXmlPart` where the XPath resolves to an XML node. + * Gets the collection of reply objects associated with the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - source?: Word.CustomXmlPart; - } - /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class CustomXmlPrefixMappingCollection extends OfficeExtension.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.CustomXmlPrefixMapping[]; + readonly replies: Word.CommentReplyCollection; /** - * Adds a custom namespace/prefix mapping to use when querying an item. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + */ + readonly authorEmail: string; + /** + * Gets the name of the comment's author. * - * @param prefix The prefix to associate with the namespace. - * @param namespaceUri The namespace URI to map. + * @remarks + * [Api set: WordApi 1.4] */ - addNamespace(prefix: string, namespaceUri: string): OfficeExtension.ClientResult; + readonly authorName: string; /** - * Returns the number of items in the collection. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - getCount(): OfficeExtension.ClientResult; + content: string; /** - * Returns a `CustomXmlPrefixMapping` object that represents the specified item in the collection. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + */ + readonly creationDate: Date; + /** + * Gets the ID of the comment. * - * @param index A number that identifies the index location of a paragraph object. + * @remarks + * [Api set: WordApi 1.4] */ - getItem(index: number): Word.CustomXmlPrefixMapping; + readonly id: string; /** - * Gets the namespace corresponding to the specified prefix. + * 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] + */ + 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. * - * @param prefix The prefix to look up. + * @remarks + * [Api set: WordApi 1.4] */ - lookupNamespace(prefix: string): OfficeExtension.ClientResult; + delete(): void; /** - * Gets the prefix corresponding to the specified namespace. + * Gets the range in the main document where the comment is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + */ + getRange(): Word.Range; + /** + * Adds a new reply to the end of the comment thread. * - * @param namespaceUri The namespace URI to look up. + * @remarks + * [Api set: WordApi 1.4] + * + * @param replyText Required. Reply text. */ - lookupPrefix(namespaceUri: string): OfficeExtension.ClientResult; + 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.CustomXmlPrefixMappingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPrefixMappingCollection; + 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.CustomXmlPrefixMappingCollection; + 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?: OfficeExtension.LoadOption): Word.CustomXmlPrefixMappingCollection; + 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.CustomXmlPrefixMappingCollection; + 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.CustomXmlPrefixMappingCollection; + 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.CustomXmlPrefixMappingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.CustomXmlPrefixMappingCollectionData; + toJSON(): Word.Interfaces.CommentData; } /** - * Represents a `CustomXmlPrefixMapping` object. + * Contains a collection of {@link Word.Comment} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - class CustomXmlPrefixMapping extends OfficeExtension.ClientObject { + 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 unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Gets the first comment in the collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly namespaceUri: string; + getFirst(): Word.Comment; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly prefix: string; + 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.CustomXmlPrefixMappingLoadOptions): Word.CustomXmlPrefixMapping; + 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.CustomXmlPrefixMapping; + 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?: { - select?: string; - expand?: string; - }): Word.CustomXmlPrefixMapping; + 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.CustomXmlPrefixMapping; + 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.CustomXmlPrefixMapping; + 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.CustomXmlPrefixMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingData`) that contains shallow copies of any loaded child properties from the original object. + * 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.CustomXmlPrefixMappingData; + toJSON(): Word.Interfaces.CommentCollectionData; } /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. - * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - class CustomXmlSchema extends OfficeExtension.ClientObject { + 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; /** - * Gets the location of the schema on a computer. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly location: string; + bold: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * 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] */ - readonly namespaceUri: string; + hyperlink: string; /** - * Deletes this schema from the {@link Word.CustomXmlSchemaCollection} object. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - delete(): void; + readonly isEmpty: boolean; /** - * Reloads the schema from a file. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - reload(): void; + 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.CustomXmlSchemaLoadOptions): Word.CustomXmlSchema; + 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.CustomXmlSchema; + 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. * @@ -98983,648 +99262,1191 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.CustomXmlSchema; + }): 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.CustomXmlSchema; + 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.CustomXmlSchema; + 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.CustomXmlSchema` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaData`) that contains shallow copies of any loaded child properties from the original object. + * 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.CustomXmlSchemaData; + toJSON(): Word.Interfaces.CommentContentRangeData; } /** - * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. + * Represents a comment reply in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - class CustomXmlSchemaCollection extends OfficeExtension.ClientObject { + 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; - /** Gets the loaded child items in this collection. */ - readonly items: Word.CustomXmlSchema[]; /** - * Adds one or more schemas to the schema collection that can then be added to a stream in the data store and to the schema library. + * Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options Optional. The options that define the schema to be added. + * [Api set: WordApi 1.4] */ - add(options?: Word.CustomXmlAddSchemaOptions): Word.CustomXmlSchema; + contentRange: Word.CommentContentRange; /** - * Adds an existing schema collection to the current schema collection. + * Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param schemaCollection The schema collection to add. + * [Api set: WordApi 1.4] */ - addCollection(schemaCollection: Word.CustomXmlSchemaCollection): Word.CustomXmlSchemaCollection; + readonly parentComment: Word.Comment; /** - * Returns the number of items in the collection. + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - getCount(): OfficeExtension.ClientResult; + readonly authorEmail: string; /** - * Returns a `CustomXmlSchema` object that represents the specified item in the collection. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param index A number that identifies the index location of a paragraph object. + * [Api set: WordApi 1.4] */ - getItem(index: number): Word.CustomXmlSchema; + readonly authorName: string; /** - * Returns the number of items in the collection. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - getNamespaceUri(): OfficeExtension.ClientResult; + content: string; /** - * Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary). + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - validate(): OfficeExtension.ClientResult; + readonly creationDate: Date; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the ID of the comment reply. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.4] */ - load(options?: Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlSchemaCollection; + readonly id: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - load(propertyNames?: string | string[]): Word.CustomXmlSchemaCollection; - /** + 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?: OfficeExtension.LoadOption): Word.CustomXmlSchemaCollection; + 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.CustomXmlSchemaCollection; + 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.CustomXmlSchemaCollection; + 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.CustomXmlSchemaCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.CustomXmlSchemaCollectionData; + toJSON(): Word.Interfaces.CommentReplyData; } /** - * Adds one or more schemas to a schema collection that can then be added to a stream in the data store and to the schema library. + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. + * + * @remarks + * [Api set: WordApi 1.4] + */ + 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 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 CustomXmlAddSchemaOptions { + class XmlMapping extends OfficeExtension.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 alias of the schema to be added to the collection. However, if the alias already exists in the Schema Library, the schema can be found using this value. + * 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 */ - alias?: string; + readonly customXmlNode: Word.CustomXmlNode; /** - * If provided, specifies the location of the schema on a disk. If this property is specified, the schema is added to the collection and to the Schema Library. + * 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 */ - fileName?: string; + readonly customXmlPart: Word.CustomXmlPart; /** - * If provided, specifies whether, in the case where the schema is being added to the Schema Library, the Schema Library keys should be written to the registry (`HKEY_LOCAL_MACHINE` for all users or `HKEY_CURRENT_USER` for just the current user). The property defaults to `false` and writes to `HKEY_CURRENT_USER`. + * 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 */ - installForAllUsers?: boolean; + readonly isMapped: boolean; /** - * If provided, specifies the namespace of the schema to be added to the collection. However, if the schema already exists in the Schema Library, the schema will be retrieved from there. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: string; - } - /** - * Represents a collection of {@link Word.CustomXmlValidationError} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class CustomXmlValidationErrorCollection extends OfficeExtension.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.CustomXmlValidationError[]; + readonly prefixMappings: string; /** - * Adds a `CustomXmlValidationError` object containing an XML validation error to the `CustomXmlValidationErrorCollection` object. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + readonly xpath: 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.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.XmlMapping): void; + /** + * Deletes the XML mapping from the parent content control. * - * @param node The XML node where the error occurred. - * @param errorName The name of the error. - * @param options Optional. The options that define the error message and other settings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - add(node: Word.CustomXmlNode, errorName: string, options?: Word.CustomXmlAddValidationErrorOptions): OfficeExtension.ClientResult; + delete(): void; /** - * Returns the number of items in the collection. + * Allows creating or changing the XML mapping on the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xPath The XPath expression to evaluate. + * @param options Optional. The options available for setting the XML mapping. */ - getCount(): OfficeExtension.ClientResult; + setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult; /** - * Returns a `CustomXmlValidationError` object that represents the specified item in the collection. + * Allows creating or changing the XML data mapping on the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a paragraph object. + * @param node The custom XML node to map. */ - getItem(index: number): Word.CustomXmlValidationError; + setMappingByNode(node: Word.CustomXmlNode): 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.CustomXmlValidationErrorCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlValidationErrorCollection; + load(options?: Word.Interfaces.XmlMappingLoadOptions): Word.XmlMapping; /** * Queues up a command to load the specified properties of the object. You must 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.CustomXmlValidationErrorCollection; + load(propertyNames?: string | string[]): Word.XmlMapping; /** * 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.CustomXmlValidationErrorCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.XmlMapping; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.CustomXmlValidationErrorCollection; + track(): Word.XmlMapping; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.CustomXmlValidationErrorCollection; + untrack(): Word.XmlMapping; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlValidationErrorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlValidationErrorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.XmlMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlMappingData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CustomXmlValidationErrorCollectionData; + toJSON(): Word.Interfaces.XmlMappingData; } /** - * The options that define the descriptive error text and the state of `clearedOnUpdate`. + * The options that define the prefix mapping and the source of the custom XML data. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CustomXmlAddValidationErrorOptions { + interface XmlSetMappingOptions { /** - * If provided, specifies whether the error is to be cleared from the {@link Word.CustomXmlValidationErrorCollection} when the XML is corrected and updated. + * If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method. If omitted, Word uses the set of prefix mappings for the specified custom XML part in the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearedOnUpdate?: boolean; + prefixMapping?: string; /** - * If provided, specifies the descriptive error text. + * If provided, specifies the desired custom XML data to map the content control to. If this property is omitted, the XPath is evaluated against all custom XML in the current document, and the mapping is established with the first `CustomXmlPart` where the XPath resolves to an XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - errorText?: string; + source?: Word.CustomXmlPart; } /** - * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class CustomXmlValidationError extends OfficeExtension.ClientObject { + class CustomXmlPrefixMappingCollection extends OfficeExtension.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.CustomXmlPrefixMapping[]; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Adds a custom namespace/prefix mapping to use when querying an item. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly node: Word.CustomXmlNode; - /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param prefix The prefix to associate with the namespace. + * @param namespaceUri The namespace URI to map. */ - readonly errorCode: number; + addNamespace(prefix: string, namespaceUri: string): OfficeExtension.ClientResult; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly name: string; + getCount(): OfficeExtension.ClientResult; /** - * Gets the text in the `CustomXmlValidationError` object. + * Returns a `CustomXmlPrefixMapping` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index A number that identifies the index location of a paragraph object. */ - readonly text: string; + getItem(index: number): Word.CustomXmlPrefixMapping; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Gets the namespace corresponding to the specified prefix. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param prefix The prefix to look up. */ - readonly type: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on 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.CustomXmlValidationErrorUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.CustomXmlValidationError): void; + lookupNamespace(prefix: string): OfficeExtension.ClientResult; /** - * Deletes this `CustomXmlValidationError` object. + * Gets the prefix corresponding to the specified namespace. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param namespaceUri The namespace URI to look up. */ - delete(): void; + lookupPrefix(namespaceUri: 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.CustomXmlValidationErrorLoadOptions): Word.CustomXmlValidationError; + load(options?: Word.Interfaces.CustomXmlPrefixMappingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPrefixMappingCollection; /** * Queues up a command to load the specified properties of the object. You must 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.CustomXmlValidationError; + load(propertyNames?: string | string[]): Word.CustomXmlPrefixMappingCollection; /** * 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.CustomXmlValidationError; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPrefixMappingCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.CustomXmlValidationError; + track(): Word.CustomXmlPrefixMappingCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.CustomXmlValidationError; + untrack(): Word.CustomXmlPrefixMappingCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlValidationError` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlValidationErrorData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.CustomXmlPrefixMappingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.CustomXmlValidationErrorData; + toJSON(): Word.Interfaces.CustomXmlPrefixMappingCollectionData; } /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * Represents a `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class CustomXmlNodeCollection extends OfficeExtension.ClientObject { + class CustomXmlPrefixMapping extends OfficeExtension.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.CustomXmlNode[]; /** - * Returns the number of items in the collection. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getCount(): OfficeExtension.ClientResult; + readonly namespaceUri: string; /** - * Returns a `CustomXmlNode` object that represents the specified item in the collection. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of a CustomXMLNode object. */ - getItem(index: number): Word.CustomXmlNode; + readonly prefix: 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.CustomXmlNodeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlNodeCollection; + load(options?: Word.Interfaces.CustomXmlPrefixMappingLoadOptions): Word.CustomXmlPrefixMapping; /** * Queues up a command to load the specified properties of the object. You must 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.CustomXmlNodeCollection; + load(propertyNames?: string | string[]): Word.CustomXmlPrefixMapping; /** * 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.CustomXmlNodeCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.CustomXmlPrefixMapping; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.CustomXmlNodeCollection; + track(): Word.CustomXmlPrefixMapping; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.CustomXmlNodeCollection; + untrack(): Word.CustomXmlPrefixMapping; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.CustomXmlPrefixMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CustomXmlNodeCollectionData; + toJSON(): Word.Interfaces.CustomXmlPrefixMappingData; } /** - * The options that define the prefix mapping and the source of the custom XML data. + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CustomXmlAppendChildNodeOptions { + class CustomXmlSchema extends OfficeExtension.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 base name of the element to be appended. + * Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + readonly location: string; /** - * If provided, specifies the namespace of the element to be appended. This property is required to append nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: string; + readonly namespaceUri: string; /** - * If provided, specifies the type of node to append. If the property isn't specified, it's assumed to be of type `element`. + * Deletes this schema from the {@link Word.CustomXmlSchemaCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + delete(): void; /** - * If provided, specifies the value of the appended node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * Reloads the schema from a file. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: string; + reload(): 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.CustomXmlSchemaLoadOptions): Word.CustomXmlSchema; + /** + * Queues up a command to load the specified properties of the object. You must 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.CustomXmlSchema; + /** + * 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.CustomXmlSchema; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CustomXmlSchema; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CustomXmlSchema; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlSchema` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CustomXmlSchemaData; } /** - * Inserts a new node just before the context node in the tree. + * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CustomXmlInsertNodeBeforeOptions { + class CustomXmlSchemaCollection extends OfficeExtension.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.CustomXmlSchema[]; /** - * If provided, specifies the base name of the element to be inserted. + * Adds one or more schemas to the schema collection that can then be added to a stream in the data store and to the schema library. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. The options that define the schema to be added. */ - name?: string; + add(options?: Word.CustomXmlAddSchemaOptions): Word.CustomXmlSchema; /** - * If provided, specifies the namespace of the element to be inserted. This property is required to insert nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * Adds an existing schema collection to the current schema collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param schemaCollection The schema collection to add. */ - namespaceUri?: string; + addCollection(schemaCollection: Word.CustomXmlSchemaCollection): Word.CustomXmlSchemaCollection; /** - * If provided, specifies the context node. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.CustomXmlNode; + getCount(): OfficeExtension.ClientResult; /** - * If provided, specifies the type of node to append. If the property isn't specified, it's assumed to be of type `element`. + * Returns a `CustomXmlSchema` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index A number that identifies the index location of a paragraph object. */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + getItem(index: number): Word.CustomXmlSchema; /** - * If provided, specifies the value of the inserted node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: string; - } - /** - * Inserts a new node just before the context node in the tree. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlInsertSubtreeBeforeOptions { + getNamespaceUri(): OfficeExtension.ClientResult; /** - * If provided, specifies the context node. + * Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.CustomXmlNode; + validate(): 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.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlSchemaCollection; + /** + * Queues up a command to load the specified properties of the object. You must 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.CustomXmlSchemaCollection; + /** + * 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.CustomXmlSchemaCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CustomXmlSchemaCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CustomXmlSchemaCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlSchemaCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CustomXmlSchemaCollectionData; } /** - * Removes the specified child node and replaces it with a different node in the same location. + * Adds one or more schemas to a schema collection that can then be added to a stream in the data store and to the schema library. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CustomXmlReplaceChildNodeOptions { + interface CustomXmlAddSchemaOptions { /** - * If provided, specifies the base name of the replacement element. + * If provided, specifies the alias of the schema to be added to the collection. However, if the alias already exists in the Schema Library, the schema can be found using this value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + alias?: string; /** - * If provided, specifies the namespace of the replacement element. This property is required to replace nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * If provided, specifies the location of the schema on a disk. If this property is specified, the schema is added to the collection and to the Schema Library. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: string; + fileName?: string; /** - * If provided, specifies the type of the replacement node. If the property isn't specified, it's assumed to be of type `element`. + * If provided, specifies whether, in the case where the schema is being added to the Schema Library, the Schema Library keys should be written to the registry (`HKEY_LOCAL_MACHINE` for all users or `HKEY_CURRENT_USER` for just the current user). The property defaults to `false` and writes to `HKEY_CURRENT_USER`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + installForAllUsers?: boolean; /** - * If provided, specifies the value of the replacement node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * If provided, specifies the namespace of the schema to be added to the collection. However, if the schema already exists in the Schema Library, the schema will be retrieved from there. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: string; + namespaceUri?: string; } /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * Represents a collection of {@link Word.CustomXmlValidationError} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class CustomXmlNode extends OfficeExtension.ClientObject { + class CustomXmlValidationErrorCollection extends OfficeExtension.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.CustomXmlValidationError[]; /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * Adds a `CustomXmlValidationError` object containing an XML validation error to the `CustomXmlValidationErrorCollection` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param node The XML node where the error occurred. + * @param errorName The name of the error. + * @param options Optional. The options that define the error message and other settings. */ - readonly attributes: Word.CustomXmlNodeCollection; + add(node: Word.CustomXmlNode, errorName: string, options?: Word.CustomXmlAddValidationErrorOptions): OfficeExtension.ClientResult; /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly childNodes: Word.CustomXmlNodeCollection; + getCount(): OfficeExtension.ClientResult; /** - * 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`. + * Returns a `CustomXmlValidationError` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index A number that identifies the index location of a paragraph object. */ - readonly firstChild: Word.CustomXmlNode; + getItem(index: number): Word.CustomXmlValidationError; /** - * 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`. + * 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 lastChild: Word.CustomXmlNode; + load(options?: Word.Interfaces.CustomXmlValidationErrorCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlValidationErrorCollection; /** - * 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`. + * 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 nextSibling: Word.CustomXmlNode; + load(propertyNames?: string | string[]): Word.CustomXmlValidationErrorCollection; /** - * Gets the object representing the part associated with this node. + * 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 ownerPart: Word.CustomXmlPart; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlValidationErrorCollection; /** - * 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 + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the 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 parentNode: Word.CustomXmlNode; + track(): Word.CustomXmlValidationErrorCollection; /** - * 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 + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to 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 previousSibling: Word.CustomXmlNode; + untrack(): Word.CustomXmlValidationErrorCollection; /** - * Gets the base name of the node without the namespace prefix, if one exists. - * - * @remarks + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlValidationErrorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlValidationErrorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CustomXmlValidationErrorCollectionData; + } + /** + * The options that define the descriptive error text and the state of `clearedOnUpdate`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlAddValidationErrorOptions { + /** + * If provided, specifies whether the error is to be cleared from the {@link Word.CustomXmlValidationErrorCollection} when the XML is corrected and updated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearedOnUpdate?: boolean; + /** + * If provided, specifies the descriptive error text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + errorText?: string; + } + /** + * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class CustomXmlValidationError extends OfficeExtension.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 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 + */ + readonly node: Word.CustomXmlNode; + /** + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly errorCode: number; + /** + * 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 + */ + readonly name: string; + /** + * Gets the text in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly text: string; + /** + * Gets the type of error generated from the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on 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.CustomXmlValidationErrorUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CustomXmlValidationError): void; + /** + * Deletes this `CustomXmlValidationError` object. + * + * @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.CustomXmlValidationErrorLoadOptions): Word.CustomXmlValidationError; + /** + * Queues up a command to load the specified properties of the object. You must 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.CustomXmlValidationError; + /** + * 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.CustomXmlValidationError; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CustomXmlValidationError; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CustomXmlValidationError; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlValidationError` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlValidationErrorData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CustomXmlValidationErrorData; + } + /** + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class CustomXmlNodeCollection extends OfficeExtension.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.CustomXmlNode[]; + /** + * Returns the number of items in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * Returns a `CustomXmlNode` object that represents the specified item in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a CustomXMLNode object. + */ + getItem(index: number): Word.CustomXmlNode; + /** + * Queues up a command to load the specified properties 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.CustomXmlNodeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlNodeCollection; + /** + * Queues up a command to load the specified properties of the object. You must 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.CustomXmlNodeCollection; + /** + * 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.CustomXmlNodeCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CustomXmlNodeCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CustomXmlNodeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CustomXmlNodeCollectionData; + } + /** + * The options that define the prefix mapping and the source of the custom XML data. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlAppendChildNodeOptions { + /** + * If provided, specifies the base name of the element to be appended. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * If provided, specifies the namespace of the element to be appended. This property is required to append nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + namespaceUri?: string; + /** + * If provided, specifies the type of node to append. If the property isn't specified, it's assumed to be of type `element`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + /** + * If provided, specifies the value of the appended node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeValue?: string; + } + /** + * Inserts a new node just before the context node in the tree. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlInsertNodeBeforeOptions { + /** + * If provided, specifies the base name of the element to be inserted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * If provided, specifies the namespace of the element to be inserted. This property is required to insert nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + namespaceUri?: string; + /** + * If provided, specifies the context node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSibling?: Word.CustomXmlNode; + /** + * If provided, specifies the type of node to append. If the property isn't specified, it's assumed to be of type `element`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + /** + * If provided, specifies the value of the inserted node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeValue?: string; + } + /** + * Inserts a new node just before the context node in the tree. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlInsertSubtreeBeforeOptions { + /** + * If provided, specifies the context node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSibling?: Word.CustomXmlNode; + } + /** + * Removes the specified child node and replaces it with a different node in the same location. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlReplaceChildNodeOptions { + /** + * If provided, specifies the base name of the replacement element. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * If provided, specifies the namespace of the replacement element. This property is required to replace nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + namespaceUri?: string; + /** + * If provided, specifies the type of the replacement node. If the property isn't specified, it's assumed to be of type `element`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + /** + * If provided, specifies the value of the replacement node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeValue?: string; + } + /** + * 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 + */ + class CustomXmlNode extends OfficeExtension.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 `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly attributes: Word.CustomXmlNodeCollection; + /** + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly childNodes: Word.CustomXmlNodeCollection; + /** + * 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 + */ + readonly firstChild: Word.CustomXmlNode; + /** + * 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 + */ + readonly lastChild: Word.CustomXmlNode; + /** + * 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 + */ + readonly nextSibling: Word.CustomXmlNode; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly ownerPart: Word.CustomXmlPart; + /** + * 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 + */ + readonly parentNode: Word.CustomXmlNode; + /** + * 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 + */ + readonly previousSibling: Word.CustomXmlNode; + /** + * Gets the base name of the node without the namespace prefix, if one exists. + * + * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ @@ -99839,14 +100661,22 @@ 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 data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * 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 + */ + readonly buildingBlockGalleryContentControl: Word.BuildingBlockGalleryContentControl; + /** + * 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 data of the content control when its type is 'ComboBox'. It's `null` otherwise. + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] @@ -99860,7 +100690,15 @@ declare namespace Word { */ readonly contentControls: Word.ContentControlCollection; /** - * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise. + * 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 + */ + readonly datePickerContentControl: Word.DatePickerContentControl; + /** + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] @@ -99894,6 +100732,14 @@ declare namespace Word { * [Api set: WordApi 1.5] */ readonly footnotes: Word.NoteItemCollection; + /** + * 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 + */ + readonly groupContentControl: Word.GroupContentControl; /** * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. * @@ -99966,6 +100812,22 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * 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 + */ + readonly pictureContentControl: Word.PictureContentControl; + /** + * 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 + */ + readonly repeatingSectionContentControl: Word.RepeatingSectionContentControl; /** * Gets the collection of table objects in the content control. * @@ -100050,7 +100912,7 @@ declare namespace Word { * @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"; + 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. * @@ -100078,7 +100940,7 @@ declare namespace Word { * @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"; + 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. @@ -101519,6 +102381,22 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ readonly activeWindow: Word.Window; + /** + * Specifies a `Template` object that represents the template attached to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + attachedTemplate: Word.Template; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly bibliography: Word.Bibliography; /** * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * @@ -101540,6 +102418,22 @@ declare namespace Word { * [Api set: WordApi 1.4] */ readonly customXmlParts: Word.CustomXmlPartCollection; + /** + * 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 + */ + readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection; + /** + * Returns a `FrameCollection` object that represents all the frames in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly frames: Word.FrameCollection; /** * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * @@ -101548,6 +102442,14 @@ declare namespace Word { * @beta */ readonly hyperlinks: Word.HyperlinkCollection; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly pageSetup: Word.PageSetup; /** * Gets the properties of the document. * @@ -101576,6 +102478,22 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ readonly windows: Word.WindowCollection; + /** + * 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. * @@ -101583,6 +102501,30 @@ declare namespace Word { * [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 whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenateCaps: boolean; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected: 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. * @@ -101669,6 +102611,14 @@ declare namespace Word { * @param name Required. The case-insensitive bookmark name. */ deleteBookmark(name: string): void; + /** + * Analyzes the document text to determine the language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + detectLanguage(): void; /** * Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found. * @@ -101784,6 +102734,14 @@ declare namespace Word { * @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; + /** + * Initiates manual hyphenation of a document, one line at a time. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + manualHyphenation(): void; /** * Saves the document. * @@ -102737,6 +103695,14 @@ declare namespace Word { 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; + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly borders: Word.BorderUniversalCollection; /** * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * @@ -105024,6 +105990,14 @@ declare namespace Word { 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 borders: Word.BorderUniversalCollection; /** * Gets the collection of content control objects in the paragraph. * @@ -105143,6 +106117,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.ShadingUniversal; /** * 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. * @@ -105962,6 +106944,14 @@ declare namespace Word { 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; + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly borders: Word.BorderUniversalCollection; /** * Gets the collection of content control objects in the range. * @@ -105997,6 +106987,14 @@ declare namespace Word { * [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. * @@ -106092,6 +107090,22 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Gets the collection of sections in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sections: Word.SectionCollection; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.ShadingUniversal; /** * 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. * @@ -106099,6 +107113,14 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ readonly shapes: Word.ShapeCollection; + /** + * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tableColumns: Word.TableColumnCollection; /** * Gets the collection of table objects in the range. * @@ -106128,6 +107150,38 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly isEmpty: boolean; + /** + * 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 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. * @@ -106180,6 +107234,14 @@ declare namespace Word { * [Api set: WordApi 1.1] */ delete(): void; + /** + * Analyzes the range text to determine the language that it's written in. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + detectLanguage(): OfficeExtension.ClientResult; /** * 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. * @@ -107035,6 +108097,30 @@ declare namespace Word { * [Api set: WordApi 1.1] */ readonly body: Word.Body; + /** + * 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. @@ -107443,6 +108529,22 @@ declare namespace Word { * [Api set: WordApi 1.5] */ readonly font: Word.Font; + /** + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly frame: Word.Frame; + /** + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linkStyle: Word.Style; /** * Gets a ListTemplate object that represents the list formatting for the specified Style object. * @@ -107471,6 +108573,14 @@ declare namespace Word { * [Api set: WordApi 1.6] */ readonly tableStyle: Word.TableStyle; + /** + * Specifies whether the style is automatically redefined based on the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + automaticallyUpdate: boolean; /** * Specifies the name of an existing style to use as the base formatting of another style. * @@ -107495,6 +108605,14 @@ declare namespace Word { * @beta */ readonly description: string; + /** + * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasProofing: 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. * @@ -107502,6 +108620,22 @@ declare namespace Word { * [Api set: WordApi 1.5] */ readonly inUse: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the style. + * + * @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 style. + * + * @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"; /** * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * @@ -107509,6 +108643,22 @@ declare namespace Word { * [Api set: WordApi 1.5] */ readonly linked: boolean; + /** + * Returns the list level for the style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listLevelNumber: number; + /** + * Specifies whether the style cannot be changed or edited. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + locked: boolean; /** * Gets the name of a style in the language of the user. * @@ -107525,6 +108675,14 @@ declare namespace Word { * 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 + */ + noSpaceBetweenParagraphsOfSameStyle: boolean; /** * Specifies the priority. * @@ -107575,6 +108733,16 @@ declare namespace Word { * [Api set: WordApi 1.5] */ delete(): void; + /** + * 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 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. * @@ -107683,6 +108851,99 @@ declare namespace Word { */ 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 + */ + backgroundPatternColor: string; + /** + * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * + * @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"; + /** + * 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 + */ + 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. + * + * @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"; + /** + * 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 + */ + 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. + * + * @param options Provides options for which properties of the object to load. + */ + 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.ShadingUniversal; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ShadingUniversalData; + } /** * Represents a table in a Word document. * @@ -108377,6 +109638,295 @@ declare namespace Word { */ toJSON(): Word.Interfaces.TableCollectionData; } + /** + * Represents a table column in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.ShadingUniversal; + /** + * Returns the position of this column in a collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly columnIndex: number; + /** + * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isFirst: boolean; + /** + * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isLast: boolean; + /** + * Returns the nesting level of the column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly nestingLevel: number; + /** + * 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 + */ + preferredWidth: number; + /** + * Specifies the preferred unit of measurement to use for the width of the table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + /** + * Specifies the width of the column, in points. + * + * @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; + /** + * 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 + */ + autoFit(): void; + /** + * Deletes the column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Selects the table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): void; + /** + * Sets the width of the column in a table. + * + * @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; + /** + * Sets the width of the column in a table. + * + * @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; + /** + * Sorts the table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sort(): 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.TableColumnLoadOptions): Word.TableColumn; + /** + * Queues up a command to load the specified properties of the object. You must 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.TableColumn; + /** + * 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.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. + */ + 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 + */ + 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. + */ + add(beforeColumn?: Word.TableColumn): Word.TableColumn; + /** + * 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 + */ + autoFit(): void; + /** + * Deletes the specified columns. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Adjusts the width of the specified columns so that they are equal. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + distributeWidth(): void; + /** + * Selects the specified table columns. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): void; + /** + * Sets the width of columns in a table. + * + * @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; + /** + * Sets the width of columns in a table. + * + * @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; + /** + * Queues up a command to load the specified properties 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; + /** + * Queues up a command to load the specified properties of the object. You must 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; + /** + * 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; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any 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; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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 row in a Word document. * @@ -109104,6 +110654,267 @@ declare namespace Word { */ toJSON(): Word.Interfaces.TableBorderData; } + /** + * Represents a document template. + * + * @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; + /** + * Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; + /** + * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; + /** + * 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 + */ + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + /** + * Specifies the line break control level for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + /** + * Returns the name of the template, including the drive or Web path. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly fullName: string; + /** + * Specifies whether the spelling and grammar checker ignores documents based on this template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasNoProofing: boolean; + /** + * Specifies the character spacing adjustment for the template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + /** + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kerningByAlgorithm: boolean; + /** + * Specifies a `LanguageId` value that represents the language in the template. + * + * @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 language in the template. + * + * @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"; + /** + * Returns only the name of the document template (excluding any path or other location information). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLineBreakAfter: string; + /** + * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLineBreakBefore: string; + /** + * Returns the path to the document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly path: string; + /** + * 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 BETA (PREVIEW ONLY)] + * @beta + */ + saved: boolean; + /** + * Returns the template type. + * + * @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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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.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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a `Template` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The index of the template to retrieve. + */ + getItemAt(index: number): Word.Template; + /** + * Imports the building blocks for all templates into Microsoft Word. + * + * @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; + /** + * Queues up a command to load the specified properties of the object. You must 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; + /** + * 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; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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. + */ + toJSON(): Word.Interfaces.TemplateCollectionData; + } /** * Represents a tracked change in a Word document. * @@ -110206,12745 +112017,22644 @@ declare namespace Word { toJSON(): Word.Interfaces.ShapeTextWrapData; } /** - * Represents the possible change tracking modes. + * Represents a single item in a {@link Word.RepeatingSectionControlControl}. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ChangeTrackingMode { + 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; /** - * ChangeTracking is turned off. + * Returns the range of this repeating section item, excluding the start and end tags. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - off = "Off", + readonly range: Word.Range; /** - * ChangeTracking is turned on for everyone. - * @remarks - * [Api set: WordApi 1.4] + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - trackAll = "TrackAll", + 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; /** - * Tracking is turned on for my changes only. + * Deletes this `RepeatingSectionItem` object. + * * @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 { + delete(): void; /** + * Adds a repeating section item after this item and returns the new item. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - original = "Original", + insertItemAfter(): Word.RepeatingSectionItem; /** + * Adds a repeating section item before this item and returns the new item. + * * @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 { + insertItemBefore(): Word.RepeatingSectionItem; /** - * @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 options Provides options for which properties of the object to load. */ - unknown = "Unknown", + load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; /** - * @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 propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - normal = "Normal", + load(propertyNames?: string | string[]): Word.RepeatingSectionItem; /** - * @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. */ - added = "Added", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItem; /** - * @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. */ - deleted = "Deleted", + 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. + */ + 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 { + 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] - */ - endnote = "Endnote", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + */ + toJSON(): { + [key: string]: string; + }; } /** - * Provides information about the type of a raised event. + * Represents the `DatePickerContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum EventType { + 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; /** - * ContentControlDeleted represents the event that the content control has been deleted. + * 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 */ - contentControlDeleted = "ContentControlDeleted", + readonly placeholderText: Word.BuildingBlock; /** - * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. + * 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 */ - contentControlSelectionChanged = "ContentControlSelectionChanged", + readonly range: Word.Range; /** - * ContentControlDataChanged represents the event that the data in the content control have been changed. + * 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 */ - contentControlDataChanged = "ContentControlDataChanged", + readonly xmlMapping: Word.XmlMapping; /** - * ContentControlAdded represents the event a content control has been added to the document. + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlAdded = "ContentControlAdded", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Represents that one or more comments were deleted. + * 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 */ - commentDeleted = "CommentDeleted", + color: string; /** - * Represents that a comment was selected. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentSelected = "CommentSelected", + dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Represents that a comment was deselected. + * Specifies the format in which dates are displayed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDeselected = "CommentDeselected", + dateDisplayFormat: string; /** - * Represents that a comment or its reply was changed. + * 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 */ - commentChanged = "CommentChanged", + 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"; /** - * Represents that one or more new comments were added. + * 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 */ - commentAdded = "CommentAdded", + dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Represents that a content control has been entered. + * Gets the identification for the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlEntered = "ContentControlEntered", + readonly id: string; /** - * Represents that a content control has been exited. + * 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 */ - contentControlExited = "ContentControlExited", + isTemporary: boolean; /** - * Represents that one or more new paragraphs were added. + * 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.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphAdded = "ParagraphAdded", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Represents that one or more paragraphs were changed. + * 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 */ - paragraphChanged = "ParagraphChanged", + lockContentControl: boolean; /** - * Represents that one or more paragraphs were deleted. + * 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 */ - paragraphDeleted = "ParagraphDeleted", + lockContents: boolean; /** - * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. + * Gets whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - annotationClicked = "AnnotationClicked", + readonly showingPlaceholderText: boolean; /** - * Represents that an annotation was hovered over in the document. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - annotationHovered = "AnnotationHovered", + tag: string; /** - * Represents that one or more annotations were added in the document. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - annotationInserted = "AnnotationInserted", + title: string; /** - * Represents that one or more annotations were deleted from the document. - * @remarks - * [Api set: WordApi 1.7] + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - annotationRemoved = "AnnotationRemoved", + 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; /** - * Represents an action in the annotation pop-up. + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.8] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + copy(): void; /** + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - local = "Local", + cut(): void; /** + * Deletes this content control and the contents of the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param deleteContents Optional. If true, deletes the contents as well. */ - remote = "Remote", - } - /** - * Provides information about the content control that raised contentControlAdded event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlAddedEventArgs { + delete(deleteContents?: boolean): void; /** - * The event type. See Word.EventType for details. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; /** - * 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] - */ - interface ContentControlDataChangedEventArgs { + load(propertyNames?: string | string[]): Word.DatePickerContentControl; /** - * 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?: { + select?: string; + expand?: string; + }): Word.DatePickerContentControl; /** - * 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.DatePickerContentControl; /** - * 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.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.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.DatePickerContentControlData; } /** - * Provides information about the content control that raised contentControlDeleted event. + * Represents the `PictureContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ContentControlDeletedEventArgs { + 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 content control that raised contentControlEntered event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - 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). + * Returns the identification for the 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] - */ - interface ContentControlExitedEventArgs { + readonly id: string; /** - * The event type. See Word.EventType for details. + * 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 */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + isTemporary: boolean; /** - * Gets the content control IDs. + * 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.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * The source of the event. It can be local or remote (through coauthoring). + * 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 */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlSelectionChanged event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlSelectionChangedEventArgs { + lockContentControl: boolean; /** - * The event type. See Word.EventType for details. + * 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 */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + lockContents: boolean; /** - * Gets the content control IDs. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly showingPlaceholderText: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies a tag to identify the content control. * * @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 { + tag: string; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + title: string; /** - * The event type. See Word.EventType for details. - * - * @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. */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + 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; /** - * 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. + * Copies the content control from the active document to the Clipboard. * * @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 { + 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 1.6] + * [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 1.6] + * [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"; + delete(deleteContents?: boolean): void; /** - * 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. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphDeleted event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphDeletedEventArgs { + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * 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.6] + * @param options Provides options for which properties of the object to load. */ - source: Word.EventSource | "Local" | "Remote"; + load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; /** - * 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.6] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + load(propertyNames?: string | string[]): Word.PictureContentControl; /** - * 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. + * 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 propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - uniqueLocalIds: string[]; + 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; } /** - * Provides information about the comments that raised the comment event. + * Represents the `GroupContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CommentEventArgs { + 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; /** - * Represents how the 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 */ - changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; + readonly placeholderText: Word.BuildingBlock; /** - * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDetails: Word.CommentDetail[]; + 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 BETA (PREVIEW ONLY)] * @beta */ - source: Word.EventSource | "Local" | "Remote"; + readonly xmlMapping: Word.XmlMapping; /** - * The event type. See Word.EventType for details. + * Specifies the appearance of the content control. * * @remarks * [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"; - } - /** - * A structure for the ID and reply IDs of this comment. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CommentDetail { + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Represents the ID of this comment. + * 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 */ - id: string; + color: string; /** - * Represents the IDs of the replies to this comment. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyIds: string[]; - } - /** - * Represents how the comments in the event were changed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CommentChangeType { + readonly id: string; /** - * No comment changed event is triggered. + * 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 */ - none = "none", + isTemporary: boolean; /** - * A comment was edited. + * 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 */ - edited = "edited", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * A comment was resolved. + * 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 */ - resolved = "resolved", + lockContentControl: boolean; /** - * A comment was reopened. + * 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 */ - reopened = "reopened", + lockContents: boolean; /** - * A reply was added. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyAdded = "replyAdded", + readonly showingPlaceholderText: boolean; /** - * A reply was deleted. + * Specifies a tag to identify the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyDeleted = "replyDeleted", + tag: string; /** - * A reply was edited. + * Specifies the title for the content 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 { - /** - * @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", + title: string; /** - * Contains a whole table. - * @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. */ - richTextTable = "RichTextTable", + 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 */ - plainTextInline = "PlainTextInline", + 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 */ - plainTextParagraph = "PlainTextParagraph", + 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. */ - picture = "Picture", + 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. */ - buildingBlockGallery = "BuildingBlockGallery", + 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 */ - checkBox = "CheckBox", + 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. */ - comboBox = "ComboBox", + 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. */ - dropDownList = "DropDownList", + 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. */ - datePicker = "DatePicker", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.GroupContentControl; /** - * @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. */ - repeatingSection = "RepeatingSection", + track(): Word.GroupContentControl; /** - * Identifies a rich text content control. - * @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. */ - richText = "RichText", + 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. */ - plainText = "PlainText", + 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; } /** - * Represents the state of the content control. + * Represents the `BuildingBlockGalleryContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ContentControlState { + 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; /** - * Error state. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - error = "Error", + readonly placeholderText: Word.BuildingBlock; /** - * Warning state. + * Returns a `Range` object that represents the contents of the content control in the active document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - warning = "Warning", - } - /** - * The supported styles for underline format. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum UnderlineType { + readonly range: Word.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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + readonly xmlMapping: Word.XmlMapping; /** - * No underline. + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Warning: hidden has been deprecated. - * @deprecated Hidden is no longer supported. + * Specifies the category for the building block content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden = "Hidden", + buildingBlockCategory: string; /** - * Warning: dotLine has been deprecated. - * @deprecated DotLine is no longer supported. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotLine = "DotLine", + 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"; /** - * A single underline. This is the default value. + * 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 */ - single = "Single", + color: string; /** - * Only underline individual words. + * Gets the identification for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - word = "Word", + readonly id: string; /** - * A double underline. + * 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 */ - double = "Double", + isTemporary: boolean; /** - * A single thick underline. + * 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 */ - thick = "Thick", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * A dotted underline. + * 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 */ - dotted = "Dotted", + 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 */ - dottedHeavy = "DottedHeavy", + lockContents: boolean; /** - * A single dash 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 */ - dashLine = "DashLine", + readonly showingPlaceholderText: boolean; /** + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineHeavy = "DashLineHeavy", + tag: string; /** + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineLong = "DashLineLong", + 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. */ - dashLineLongHeavy = "DashLineLongHeavy", + 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; /** - * An alternating dot-dash underline. + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashLine = "DotDashLine", + 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 */ - dotDashLineHeavy = "DotDashLineHeavy", + cut(): void; /** - * An alternating dot-dot-dash underline. + * 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. */ - twoDotDashLine = "TwoDotDashLine", + 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 The options for configuring the content control's placeholder text. */ - twoDotDashLineHeavy = "TwoDotDashLineHeavy", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * A single wavy 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 options Provides options for which properties of the object to load. */ - wave = "Wave", + load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): 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 propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - waveHeavy = "WaveHeavy", + 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. */ - waveDouble = "WaveDouble", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockGalleryContentControl; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any 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; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + */ + 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. + * Calendar types. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BodyType { + enum CalendarType { /** - * Unknown body type. + * Western calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + western = "Western", /** - * Main document body. + * Arabic calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mainDoc = "MainDoc", + arabic = "Arabic", /** - * Section body. + * Hebrew calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - section = "Section", + hebrew = "Hebrew", /** - * Header body. + * Taiwan calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - header = "Header", + taiwan = "Taiwan", /** - * Footer body. + * Japanese calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footer = "Footer", + japan = "Japan", /** - * Table cell body. + * Thai calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableCell = "TableCell", + thai = "Thai", /** - * Footnote body. + * Korean calendar type. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnote = "Footnote", + korean = "Korean", /** - * Endnote body. + * Saka Era calendar type. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - endnote = "Endnote", + sakaEra = "SakaEra", /** - * Note body e.g., endnote, footnote. + * Transliterated English calendar type. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noteItem = "NoteItem", + translitEnglish = "TranslitEnglish", /** - * Shape body. + * Transliterated French calendar type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shape = "Shape", + translitFrench = "TranslitFrench", + /** + * Umm al-Qura calendar type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + umalqura = "Umalqura", } /** - * This enum sets where the cursor (insertion point) in the document is after a selection. + * Date storage formats for {@link Word.DatePickerContentControl}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum SelectionMode { + enum ContentControlDateStorageFormat { /** - * The entire range is selected. + * Stores the date as text. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select = "Select", + text = "Text", /** - * The cursor is at the beginning of the selection (just before the start of the selected range). + * Stores the date as a date object. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - start = "Start", + date = "Date", /** - * The cursor is at the end of the selection (just after the end of the selected range). + * Stores the date as a date-time object. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - end = "End", + dateTime = "DateTime", } /** + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ImageFormat { + 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; /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unsupported = "Unsupported", + readonly borders: Word.BorderUniversalCollection; /** + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - undefined = "Undefined", + readonly range: Word.Range; /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bmp = "Bmp", + readonly shading: Word.ShadingUniversal; /** + * Specifies the height (in points) of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - jpeg = "Jpeg", + height: number; /** + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gif = "Gif", + heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tiff = "Tiff", + horizontalDistanceFromText: number; /** + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - png = "Png", + horizontalPosition: number; /** + * Specifies if the frame is locked. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - icon = "Icon", + lockAnchor: boolean; /** + * Specifies the relative horizontal position of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - exif = "Exif", + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** + * Specifies the relative vertical position of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wmf = "Wmf", + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** + * Specifies if document text wraps around the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - emf = "Emf", + textWrap: boolean; /** + * Specifies the vertical distance (in points) between the frame and the surrounding text. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pict = "Pict", + verticalDistanceFromText: number; /** + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pdf = "Pdf", + verticalPosition: number; /** + * Specifies the width (in points) of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + width: number; /** - * 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. + * Specifies the rule used to determine the width of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - whole = "Whole", + widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * The starting point of the object. For content control, it's the point after the opening tag. - * @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. */ - start = "Start", + 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; /** - * 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. + * Copies the frame to the Clipboard. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - end = "End", + copy(): void; /** - * For content control only. It's the point before the opening tag. + * 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 */ - before = "Before", + cut(): void; /** - * 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. + * Deletes the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - after = "After", + delete(): void; /** - * The range between 'Start' and 'End'. + * Selects the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content = "Content", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum LocationRelation { + select(): void; /** - * Indicates that this instance and the range are in different sub-documents. - * @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. */ - unrelated = "Unrelated", + load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame; /** - * Indicates that this instance and the range represent the same 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 propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - equal = "Equal", + load(propertyNames?: string | string[]): Word.Frame; /** - * 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] + * 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. */ - containsStart = "ContainsStart", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Frame; /** - * 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] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - containsEnd = "ContainsEnd", + track(): Word.Frame; /** - * 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] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - contains = "Contains", + untrack(): Word.Frame; /** - * 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] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - insideStart = "InsideStart", + 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[]; /** - * 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. + * 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. */ - insideEnd = "InsideEnd", + add(range: Word.Range): Word.Frame; /** - * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. + * Deletes the `FrameCollection` object. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inside = "Inside", + delete(): void; /** - * Indicates that this instance occurs before, and is adjacent to, the range. + * 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. */ - adjacentBefore = "AdjacentBefore", + getItem(index: number): Word.Frame; /** - * Indicates that this instance starts before the range and overlaps the range's first character. - * @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. */ - overlapsBefore = "OverlapsBefore", + load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; /** - * Indicates that this instance occurs before the 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 propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - before = "Before", + load(propertyNames?: string | string[]): Word.FrameCollection; /** - * Indicates that this instance occurs after, and is adjacent to, the 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 propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - adjacentAfter = "AdjacentAfter", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; /** - * Indicates that this instance starts inside the range and overlaps the range’s last character. - * @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. */ - overlapsAfter = "OverlapsAfter", + track(): Word.FrameCollection; /** - * Indicates that this instance occurs after the range. - * @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. */ - after = "After", + untrack(): Word.FrameCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + */ + toJSON(): Word.Interfaces.FrameCollectionData; } /** + * Represents a document library version. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BorderLocation { + 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 */ - top = "Top", + 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 */ - left = "Left", + 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 */ - bottom = "Bottom", + 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. */ - right = "Right", + 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. */ - insideHorizontal = "InsideHorizontal", + 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. */ - insideVertical = "InsideVertical", + 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. */ - inside = "Inside", + 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. */ - outside = "Outside", + 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. */ - all = "All", + toJSON(): Word.Interfaces.DocumentLibraryVersionData; } /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum CellPaddingLocation { + 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. */ - top = "Top", + 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 */ - left = "Left", + 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. */ - bottom = "Bottom", + 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. */ - right = "Right", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersionCollection; + /** + * 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; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any 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; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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 width of a style's border. + * Represents the possible change tracking modes. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - enum BorderWidth { + enum ChangeTrackingMode { /** - * None width. + * ChangeTracking is turned off. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - none = "None", + off = "Off", /** - * 0.25 point. + * ChangeTracking is turned on for everyone. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - pt025 = "Pt025", + trackAll = "TrackAll", /** - * 0.50 point. + * Tracking is turned on for my changes only. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - pt050 = "Pt050", + trackMineOnly = "TrackMineOnly", + } + /** + * Specify the current version or the original version of the text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingVersion { /** - * 0.75 point. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - pt075 = "Pt075", + original = "Original", /** - * 1.00 point. This is the default. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - pt100 = "Pt100", - /** - * 1.50 points. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - pt150 = "Pt150", - /** - * 2.25 points. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - pt225 = "Pt225", + current = "Current", + } + /** + * Specify the track state when ChangeTracking is on. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum ChangeTrackingState { /** - * 3.00 points. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt300 = "Pt300", + unknown = "Unknown", /** - * 4.50 points. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt450 = "Pt450", + normal = "Normal", /** - * 6.00 points. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt600 = "Pt600", + added = "Added", /** - * Mixed width. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + deleted = "Deleted", } /** + * TrackedChange type. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - enum BorderType { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - mixed = "Mixed", + enum TrackedChangeType { /** + * No revision. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ none = "None", /** + * Add change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - single = "Single", + added = "Added", /** + * Delete change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - double = "Double", + deleted = "Deleted", /** + * Format change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - dotted = "Dotted", + formatted = "Formatted", + } + /** + * Note item type + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum NoteItemType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - dashed = "Dashed", + footnote = "Footnote", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - dotDashed = "DotDashed", + 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] */ - dot2Dashed = "Dot2Dashed", + 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] */ - triple = "Triple", + 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] */ - thinThickSmall = "ThinThickSmall", + 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] */ - thickThinSmall = "ThickThinSmall", + contentControlAdded = "ContentControlAdded", /** + * Represents that one or more comments were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinSmall = "ThinThickThinSmall", + commentDeleted = "CommentDeleted", /** + * Represents that a comment was selected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickMed = "ThinThickMed", + commentSelected = "CommentSelected", /** + * Represents that a comment was deselected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thickThinMed = "ThickThinMed", + commentDeselected = "CommentDeselected", /** + * Represents that a comment or its reply was changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinMed = "ThinThickThinMed", + commentChanged = "CommentChanged", /** + * Represents that one or more new comments were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickLarge = "ThinThickLarge", + commentAdded = "CommentAdded", /** + * Represents that a content control has been entered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - thickThinLarge = "ThickThinLarge", + contentControlEntered = "ContentControlEntered", /** + * Represents that a content control has been exited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - thinThickThinLarge = "ThinThickThinLarge", + contentControlExited = "ContentControlExited", /** + * Represents that one or more new paragraphs were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - wave = "Wave", + paragraphAdded = "ParagraphAdded", /** + * Represents that one or more paragraphs were changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - doubleWave = "DoubleWave", + paragraphChanged = "ParagraphChanged", /** + * Represents that one or more paragraphs were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - dashedSmall = "DashedSmall", + 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] */ - dashDotStroked = "DashDotStroked", + annotationClicked = "AnnotationClicked", /** + * Represents that an annotation was hovered over in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - threeDEmboss = "ThreeDEmboss", + annotationHovered = "AnnotationHovered", /** + * Represents that one or more annotations were added in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - threeDEngrave = "ThreeDEngrave", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum VerticalAlignment { + annotationInserted = "AnnotationInserted", /** + * Represents that one or more annotations were deleted from the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - mixed = "Mixed", + annotationRemoved = "AnnotationRemoved", /** + * Represents an action in the annotation pop-up. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.8] */ - top = "Top", + 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] */ - center = "Center", + local = "Local", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - bottom = "Bottom", + remote = "Remote", } /** + * Provides information about the content control that raised contentControlAdded event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - enum ListLevelType { + interface ContentControlAddedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - bullet = "Bullet", + 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] */ - number = "Number", + 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] */ - picture = "Picture", + source: Word.EventSource | "Local" | "Remote"; } /** + * Provides information about the content control that raised contentControlDataChanged event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - enum ListBullet { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - custom = "Custom", + interface ContentControlDataChangedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - solid = "Solid", + 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] */ - hollow = "Hollow", + 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] */ - square = "Square", + 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] */ - diamonds = "Diamonds", + 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] */ - arrow = "Arrow", + 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] */ - checkmark = "Checkmark", + source: Word.EventSource | "Local" | "Remote"; } /** + * Provides information about the content control that raised contentControlEntered event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - enum ListNumbering { + interface ContentControlEnteredEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - none = "None", + 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] */ - arabic = "Arabic", + 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] */ - upperRoman = "UpperRoman", + 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] */ - lowerRoman = "LowerRoman", + 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] */ - upperLetter = "UpperLetter", + 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] */ - lowerLetter = "LowerLetter", + source: Word.EventSource | "Local" | "Remote"; } /** - * Represents the built-in style in a Word document. + * Provides information about the content control that raised contentControlSelectionChanged event. * * @remarks - * [Api set: WordApi 1.3] - * - * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. + * [Api set: WordApi 1.5] */ - enum BuiltInStyleName { + interface ContentControlSelectionChangedEventArgs { /** - * Mixed styles or other style not in this list. + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - other = "Other", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * Reset character and paragraph style to default. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - normal = "Normal", + 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] */ - heading1 = "Heading1", + 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] */ - heading2 = "Heading2", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - heading3 = "Heading3", + 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] */ - heading4 = "Heading4", + 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] */ - heading5 = "Heading5", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - heading6 = "Heading6", + 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] */ - heading7 = "Heading7", + 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] */ - heading8 = "Heading8", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - heading9 = "Heading9", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * Table-of-content level 1. + * 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] */ - toc1 = "Toc1", + uniqueLocalIds: string[]; + } + /** + * Provides information about the comments that raised the comment event. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CommentEventArgs { /** - * Table-of-content level 2. + * Represents how the comment changed event is triggered. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc2 = "Toc2", + changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; /** - * Table-of-content level 3. + * 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 */ - toc3 = "Toc3", + commentDetails: Word.CommentDetail[]; /** - * Table-of-content level 4. + * 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 */ - toc4 = "Toc4", + source: Word.EventSource | "Local" | "Remote"; /** - * Table-of-content level 5. + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc5 = "Toc5", + 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 { /** - * Table-of-content level 6. + * Represents the ID of this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc6 = "Toc6", + id: string; /** - * Table-of-content level 7. + * Represents the IDs of the replies to this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc7 = "Toc7", + replyIds: string[]; + } + /** + * Represents how the comments in the event were changed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CommentChangeType { /** - * Table-of-content level 8. + * No comment changed event is triggered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc8 = "Toc8", + none = "none", /** - * Table-of-content level 9. + * A comment was edited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc9 = "Toc9", + edited = "edited", /** + * A comment was resolved. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnoteText = "FootnoteText", + resolved = "resolved", /** + * A comment was reopened. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - header = "Header", + reopened = "reopened", /** + * A reply was added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footer = "Footer", + replyAdded = "replyAdded", /** + * A reply was deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - caption = "Caption", + replyDeleted = "replyDeleted", /** + * A reply was edited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnoteReference = "FootnoteReference", + replyEdited = "replyEdited", + } + /** + * Specifies supported content control types and subtypes. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum ContentControlType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - endnoteReference = "EndnoteReference", + unknown = "Unknown", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - endnoteText = "EndnoteText", + richTextInline = "RichTextInline", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - title = "Title", + richTextParagraphs = "RichTextParagraphs", /** + * Contains a whole cell. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtitle = "Subtitle", + richTextTableCell = "RichTextTableCell", /** + * Contains a whole row. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - hyperlink = "Hyperlink", + richTextTableRow = "RichTextTableRow", /** + * Contains a whole table. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - strong = "Strong", + richTextTable = "RichTextTable", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - emphasis = "Emphasis", + plainTextInline = "PlainTextInline", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - noSpacing = "NoSpacing", + plainTextParagraph = "PlainTextParagraph", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - listParagraph = "ListParagraph", + picture = "Picture", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - quote = "Quote", + buildingBlockGallery = "BuildingBlockGallery", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseQuote = "IntenseQuote", + checkBox = "CheckBox", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtleEmphasis = "SubtleEmphasis", + comboBox = "ComboBox", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseEmphasis = "IntenseEmphasis", + dropDownList = "DropDownList", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtleReference = "SubtleReference", + datePicker = "DatePicker", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseReference = "IntenseReference", + repeatingSection = "RepeatingSection", /** + * Identifies a rich text content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - bookTitle = "BookTitle", + richText = "RichText", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - bibliography = "Bibliography", + plainText = "PlainText", /** - * Table-of-content heading. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tocHeading = "TocHeading", + 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.3] + * [Api set: WordApi 1.1] */ - tableGrid = "TableGrid", + boundingBox = "BoundingBox", /** + * Represents a content control shown as start and end markers. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable1 = "PlainTable1", + tags = "Tags", /** + * Represents a content control that isn't shown. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable2 = "PlainTable2", + hidden = "Hidden", + } + /** + * Content control level types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlLevel { /** + * Represents an inline content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plainTable3 = "PlainTable3", + inline = "Inline", /** + * Represents a paragraph-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plainTable4 = "PlainTable4", + paragraph = "Paragraph", /** + * Represents a row-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plainTable5 = "PlainTable5", + row = "Row", /** + * Represents a cell-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableGridLight = "TableGridLight", + cell = "Cell", + } + /** + * Represents the state of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlState { /** + * Error state. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable1Light = "GridTable1Light", + error = "Error", /** + * Warning state. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable1Light_Accent1 = "GridTable1Light_Accent1", + warning = "Warning", + } + /** + * The supported styles for underline format. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum UnderlineType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent2 = "GridTable1Light_Accent2", + mixed = "Mixed", /** + * No underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent3 = "GridTable1Light_Accent3", + none = "None", /** + * Warning: hidden has been deprecated. + * @deprecated Hidden is no longer supported. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent4 = "GridTable1Light_Accent4", + hidden = "Hidden", /** + * Warning: dotLine has been deprecated. + * @deprecated DotLine is no longer supported. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent5 = "GridTable1Light_Accent5", + dotLine = "DotLine", /** + * A single underline. This is the default value. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent6 = "GridTable1Light_Accent6", + single = "Single", /** + * Only underline individual words. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2 = "GridTable2", + word = "Word", /** + * A double underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent1 = "GridTable2_Accent1", + double = "Double", /** + * A single thick underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent2 = "GridTable2_Accent2", + thick = "Thick", /** + * A dotted underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent3 = "GridTable2_Accent3", + dotted = "Dotted", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent4 = "GridTable2_Accent4", + dottedHeavy = "DottedHeavy", /** + * A single dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent5 = "GridTable2_Accent5", + dashLine = "DashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent6 = "GridTable2_Accent6", + dashLineHeavy = "DashLineHeavy", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable3 = "GridTable3", + dashLineLong = "DashLineLong", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable3_Accent1 = "GridTable3_Accent1", + dashLineLongHeavy = "DashLineLongHeavy", /** + * An alternating dot-dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable3_Accent2 = "GridTable3_Accent2", + dotDashLine = "DotDashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable3_Accent3 = "GridTable3_Accent3", + dotDashLineHeavy = "DotDashLineHeavy", /** + * An alternating dot-dot-dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable3_Accent4 = "GridTable3_Accent4", + twoDotDashLine = "TwoDotDashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable3_Accent5 = "GridTable3_Accent5", + twoDotDashLineHeavy = "TwoDotDashLineHeavy", /** + * A single wavy underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable3_Accent6 = "GridTable3_Accent6", + wave = "Wave", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4 = "GridTable4", + waveHeavy = "WaveHeavy", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent1 = "GridTable4_Accent1", + 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.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent2 = "GridTable4_Accent2", + page = "Page", /** + * Warning: next has been deprecated. Use sectionNext instead. + * @deprecated Use sectionNext instead. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent3 = "GridTable4_Accent3", + next = "Next", /** + * Section break on next page. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent4 = "GridTable4_Accent4", + sectionNext = "SectionNext", /** + * New section without a corresponding page break. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent5 = "GridTable4_Accent5", + 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.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent6 = "GridTable4_Accent6", + 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.3] + * [Api set: WordApi 1.1] */ - gridTable5Dark = "GridTable5Dark", + sectionOdd = "SectionOdd", /** + * Line break. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", + 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.3] + * [Api set: WordApi 1.1] */ - gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", + before = "Before", /** + * Add content after the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", + after = "After", /** + * Prepend content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", + start = "Start", /** + * Append content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", + end = "End", /** + * Replace the contents of the current object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", + replace = "Replace", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum Alignment { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable6Colorful = "GridTable6Colorful", + mixed = "Mixed", /** + * Unknown alignment. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", + unknown = "Unknown", /** + * Alignment to the left. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", + left = "Left", /** + * Alignment to the center. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", + centered = "Centered", /** + * Alignment to the right. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", + right = "Right", /** + * Fully justified alignment. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", + 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.3] + * [Api set: WordApi 1.1] */ - gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", + primary = "Primary", /** + * Returns the header or footer on the first page of a section. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable7Colorful = "GridTable7Colorful", + firstPage = "FirstPage", /** + * Returns all headers or footers on even-numbered pages of a section. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", + 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] */ - gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", + unknown = "Unknown", /** + * Main document body. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", + mainDoc = "MainDoc", /** + * Section body. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", + section = "Section", /** + * Header body. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", + header = "Header", /** + * Footer body. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", + footer = "Footer", /** + * Table cell body. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light = "ListTable1Light", + tableCell = "TableCell", /** + * Footnote body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent1 = "ListTable1Light_Accent1", + footnote = "Footnote", /** + * Endnote body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent2 = "ListTable1Light_Accent2", + endnote = "Endnote", /** + * Note body e.g., endnote, footnote. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent3 = "ListTable1Light_Accent3", + noteItem = "NoteItem", /** + * Shape body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable1Light_Accent4 = "ListTable1Light_Accent4", - /** - * @remarks - * [Api set: WordApi 1.3] + 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 { + /** + * The entire range is selected. + * @remarks + * [Api set: WordApi 1.1] */ - listTable1Light_Accent5 = "ListTable1Light_Accent5", + select = "Select", /** + * The cursor is at the beginning of the selection (just before the start of the selected range). * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - listTable1Light_Accent6 = "ListTable1Light_Accent6", + start = "Start", /** + * The cursor is at the end of the selection (just after the end of the selected range). * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - listTable2 = "ListTable2", + end = "End", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ImageFormat { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable2_Accent1 = "ListTable2_Accent1", + unsupported = "Unsupported", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable2_Accent2 = "ListTable2_Accent2", + undefined = "Undefined", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable2_Accent3 = "ListTable2_Accent3", + bmp = "Bmp", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable2_Accent4 = "ListTable2_Accent4", + jpeg = "Jpeg", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable2_Accent5 = "ListTable2_Accent5", + gif = "Gif", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable2_Accent6 = "ListTable2_Accent6", + tiff = "Tiff", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable3 = "ListTable3", + png = "Png", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable3_Accent1 = "ListTable3_Accent1", + icon = "Icon", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable3_Accent2 = "ListTable3_Accent2", + exif = "Exif", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable3_Accent3 = "ListTable3_Accent3", + wmf = "Wmf", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable3_Accent4 = "ListTable3_Accent4", + emf = "Emf", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable3_Accent5 = "ListTable3_Accent5", + pict = "Pict", + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pdf = "Pdf", + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + 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.3] */ - listTable3_Accent6 = "ListTable3_Accent6", + 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] */ - listTable4 = "ListTable4", + 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] */ - listTable4_Accent1 = "ListTable4_Accent1", + end = "End", /** + * For content control only. It's the point before the opening tag. * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent2 = "ListTable4_Accent2", + 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] */ - listTable4_Accent3 = "ListTable4_Accent3", + after = "After", /** + * The range between 'Start' and 'End'. * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent4 = "ListTable4_Accent4", + 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] */ - listTable4_Accent5 = "ListTable4_Accent5", + unrelated = "Unrelated", /** + * Indicates that this instance and the range represent the same range. * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent6 = "ListTable4_Accent6", + 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] */ - listTable5Dark = "ListTable5Dark", + 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] */ - listTable5Dark_Accent1 = "ListTable5Dark_Accent1", + 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] */ - listTable5Dark_Accent2 = "ListTable5Dark_Accent2", + 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] */ - listTable5Dark_Accent3 = "ListTable5Dark_Accent3", + 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] */ - listTable5Dark_Accent4 = "ListTable5Dark_Accent4", + 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] */ - listTable5Dark_Accent5 = "ListTable5Dark_Accent5", + inside = "Inside", /** + * Indicates that this instance occurs before, and is adjacent to, the range. * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent6 = "ListTable5Dark_Accent6", + adjacentBefore = "AdjacentBefore", /** + * Indicates that this instance starts before the range and overlaps the range's first character. * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful = "ListTable6Colorful", + overlapsBefore = "OverlapsBefore", /** + * Indicates that this instance occurs before the range. * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", + before = "Before", /** + * Indicates that this instance occurs after, and is adjacent to, the range. * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", + adjacentAfter = "AdjacentAfter", /** + * Indicates that this instance starts inside the range and overlaps the range’s last character. * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", + overlapsAfter = "OverlapsAfter", /** + * Indicates that this instance occurs after the range. * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", + after = "After", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderLocation { /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", + top = "Top", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", + left = "Left", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful = "ListTable7Colorful", + bottom = "Bottom", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", + right = "Right", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", + insideHorizontal = "InsideHorizontal", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", + insideVertical = "InsideVertical", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", + inside = "Inside", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", + outside = "Outside", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + all = "All", } /** * @remarks * [Api set: WordApi 1.3] */ - enum DocumentPropertyType { + enum CellPaddingLocation { /** * @remarks * [Api set: WordApi 1.3] */ - string = "String", + top = "Top", /** * @remarks * [Api set: WordApi 1.3] */ - number = "Number", + left = "Left", /** * @remarks * [Api set: WordApi 1.3] */ - date = "Date", + bottom = "Bottom", /** * @remarks * [Api set: WordApi 1.3] */ - boolean = "Boolean", + right = "Right", } /** - * Represents the type of style. + * Represents the width of a style's border. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - enum StyleType { + enum BorderWidth { /** - * Represents that the style is a character style. + * None width. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - character = "Character", + none = "None", /** - * Represents that the style is a list style. Currently supported on desktop. + * 0.25 point. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - list = "List", + pt025 = "Pt025", /** - * Represents that the style is a paragraph style. + * 0.50 point. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - paragraph = "Paragraph", + pt050 = "Pt050", /** - * Represents that the style is a table style. + * 0.75 point. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - table = "Table", - } - /** - * Represents the outline levels. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum OutlineLevel { + pt075 = "Pt075", /** - * Represents outline level 1. + * 1.00 point. This is the default. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel1 = "OutlineLevel1", + pt100 = "Pt100", /** - * Represents outline level 2. + * 1.50 points. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel2 = "OutlineLevel2", + pt150 = "Pt150", /** - * Represents outline level 3. + * 2.25 points. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel3 = "OutlineLevel3", + pt225 = "Pt225", /** - * Represents outline level 4. + * 3.00 points. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel4 = "OutlineLevel4", + pt300 = "Pt300", /** - * Represents outline level 5. + * 4.50 points. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel5 = "OutlineLevel5", + pt450 = "Pt450", /** - * Represents outline level 6. + * 6.00 points. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel6 = "OutlineLevel6", + pt600 = "Pt600", /** - * Represents outline level 7. + * Mixed width. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel7 = "OutlineLevel7", + mixed = "Mixed", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderType { /** - * Represents outline level 8. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel8 = "OutlineLevel8", + mixed = "Mixed", /** - * Represents outline level 9. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel9 = "OutlineLevel9", + none = "None", /** - * Represents outline level body text, not an outline level. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevelBodyText = "OutlineLevelBodyText", - } - /** - * Specifies the close behavior for `Document.close`. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum CloseBehavior { + single = "Single", /** - * Saves the changes before closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - save = "Save", + double = "Double", /** - * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - skipSave = "SkipSave", - } - /** - * Specifies the save behavior for `Document.save`. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum SaveBehavior { + dotted = "Dotted", /** - * 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] + * [Api set: WordApi 1.3] */ - save = "Save", + dashed = "Dashed", /** - * 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] + * [Api set: WordApi 1.3] */ - prompt = "Prompt", - } - /** - * Represents the type of Field. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum FieldType { + dotDashed = "DotDashed", /** - * Represents that the field type is Add-in. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - addin = "Addin", + dot2Dashed = "Dot2Dashed", /** - * Represents that the field type is AddressBlock. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - addressBlock = "AddressBlock", + triple = "Triple", /** - * Represents that the field type is Advance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - advance = "Advance", + thinThickSmall = "ThinThickSmall", /** - * Represents that the field type is Ask. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ask = "Ask", + thickThinSmall = "ThickThinSmall", /** - * Represents that the field type is Author. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - author = "Author", + thinThickThinSmall = "ThinThickThinSmall", /** - * Represents that the field type is AutoText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - autoText = "AutoText", + thinThickMed = "ThinThickMed", /** - * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - autoTextList = "AutoTextList", + thickThinMed = "ThickThinMed", /** - * Represents that the field type is Barcode. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - barCode = "BarCode", + thinThickThinMed = "ThinThickThinMed", /** - * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - bibliography = "Bibliography", + thinThickLarge = "ThinThickLarge", /** - * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - bidiOutline = "BidiOutline", + thickThinLarge = "ThickThinLarge", /** - * Represents that the field type is Citation. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - citation = "Citation", + thinThickThinLarge = "ThinThickThinLarge", /** - * Represents that the field type is Comments. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - comments = "Comments", + wave = "Wave", /** - * Represents that the field type is Compare. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - compare = "Compare", + doubleWave = "DoubleWave", /** - * Represents that the field type is CreateDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - createDate = "CreateDate", + dashedSmall = "DashedSmall", /** - * Represents that the field type is Data. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - data = "Data", + dashDotStroked = "DashDotStroked", /** - * Represents that the field type is Database. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - database = "Database", + threeDEmboss = "ThreeDEmboss", /** - * Represents that the field type is Date. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - date = "Date", + threeDEngrave = "ThreeDEngrave", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum VerticalAlignment { /** - * Represents that the field type is DisplayBarcode. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - displayBarcode = "DisplayBarcode", + mixed = "Mixed", /** - * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - docProperty = "DocProperty", + top = "Top", /** - * Represents that the field type is DocumentVariable. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - docVariable = "DocVariable", + center = "Center", /** - * Represents that the field type is EditTime. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - editTime = "EditTime", + bottom = "Bottom", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListLevelType { /** - * Represents that the field type is Embedded. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - embedded = "Embedded", + bullet = "Bullet", /** - * Represents that the field type is Equation. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - eq = "EQ", + number = "Number", /** - * Represents that the field type is Expression. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - expression = "Expression", + picture = "Picture", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListBullet { /** - * Represents that the field type is FileName. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fileName = "FileName", + custom = "Custom", /** - * Represents that the field type is FileSize. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fileSize = "FileSize", + solid = "Solid", /** - * Represents that the field type is FillIn. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fillIn = "FillIn", + hollow = "Hollow", /** - * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formCheckbox = "FormCheckbox", + square = "Square", /** - * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formDropdown = "FormDropdown", + diamonds = "Diamonds", /** - * Represents that the field type is FormText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formText = "FormText", + arrow = "Arrow", /** - * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - gotoButton = "GotoButton", + checkmark = "Checkmark", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListNumbering { /** - * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - greetingLine = "GreetingLine", + none = "None", /** - * Represents that the field type is Hyperlink. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - hyperlink = "Hyperlink", + arabic = "Arabic", /** - * Represents that the field type is If. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - if = "If", + upperRoman = "UpperRoman", /** - * Represents that the field type is Import. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - import = "Import", + lowerRoman = "LowerRoman", /** - * Represents that the field type is Include. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - include = "Include", + upperLetter = "UpperLetter", /** - * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - includePicture = "IncludePicture", + 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 that the field type is IncludeText. + * Mixed styles or other style not in this list. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - includeText = "IncludeText", + other = "Other", /** - * Represents that the field type is Index. + * Reset character and paragraph style to default. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - index = "Index", + normal = "Normal", /** - * Represents that the field type is Information. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - info = "Info", + heading1 = "Heading1", /** - * Represents that the field type is Keywords. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - keywords = "Keywords", + heading2 = "Heading2", /** - * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lastSavedBy = "LastSavedBy", + heading3 = "Heading3", /** - * Represents that the field type is Link. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - link = "Link", + heading4 = "Heading4", /** - * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - listNum = "ListNum", + heading5 = "Heading5", /** - * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - macroButton = "MacroButton", + heading6 = "Heading6", /** - * Represents that the field type is MergeBarcode. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeBarcode = "MergeBarcode", + heading7 = "Heading7", /** - * Represents that the field type is MergeField. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeField = "MergeField", + heading8 = "Heading8", /** - * Represents that the field type is MergeRecord. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeRec = "MergeRec", + heading9 = "Heading9", /** - * Represents that the field type is MergeSequence. + * Table-of-content level 1. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeSeq = "MergeSeq", + toc1 = "Toc1", /** - * Represents that the field type is Next. + * Table-of-content level 2. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - next = "Next", + toc2 = "Toc2", /** - * Represents that the field type is NextIf. + * Table-of-content level 3. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - nextIf = "NextIf", + toc3 = "Toc3", /** - * Represents that the field type is NoteReference. + * Table-of-content level 4. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - noteRef = "NoteRef", + toc4 = "Toc4", /** - * Represents that the field type is NumberOfCharacters. + * Table-of-content level 5. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numChars = "NumChars", + toc5 = "Toc5", /** - * Represents that the field type is NumberOfPages. + * Table-of-content level 6. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numPages = "NumPages", + toc6 = "Toc6", /** - * Represents that the field type is NumberOfWords. + * Table-of-content level 7. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numWords = "NumWords", + toc7 = "Toc7", /** - * Represents that the field type is ActiveXControl. + * Table-of-content level 8. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ocx = "OCX", + toc8 = "Toc8", /** - * Represents that the field type is Page. + * Table-of-content level 9. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - page = "Page", + toc9 = "Toc9", /** - * Represents that the field type is PageReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - pageRef = "PageRef", + footnoteText = "FootnoteText", /** - * Represents that the field type is Print. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - print = "Print", + header = "Header", /** - * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - printDate = "PrintDate", + footer = "Footer", /** - * Represents that the field type is Private. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - private = "Private", + caption = "Caption", /** - * Represents that the field type is Quote. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - quote = "Quote", + footnoteReference = "FootnoteReference", /** - * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rd = "RD", + endnoteReference = "EndnoteReference", /** - * Represents that the field type is Reference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ref = "Ref", + endnoteText = "EndnoteText", /** - * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - revNum = "RevNum", + title = "Title", /** - * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - saveDate = "SaveDate", + subtitle = "Subtitle", /** - * Represents that the field type is Section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - section = "Section", + hyperlink = "Hyperlink", /** - * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - sectionPages = "SectionPages", + strong = "Strong", /** - * Represents that the field type is Sequence. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - seq = "Seq", + emphasis = "Emphasis", /** - * Represents that the field type is Set. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - set = "Set", + noSpacing = "NoSpacing", /** - * Represents that the field type is Shape. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - shape = "Shape", + listParagraph = "ListParagraph", /** - * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - skipIf = "SkipIf", + quote = "Quote", /** - * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - styleRef = "StyleRef", + intenseQuote = "IntenseQuote", /** - * Represents that the field type is Subject. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - subject = "Subject", + subtleEmphasis = "SubtleEmphasis", /** - * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - subscriber = "Subscriber", + intenseEmphasis = "IntenseEmphasis", /** - * Represents that the field type is Symbol. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - symbol = "Symbol", + subtleReference = "SubtleReference", /** - * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ta = "TA", + intenseReference = "IntenseReference", /** - * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - tc = "TC", + bookTitle = "BookTitle", /** - * Represents that the field type is Template. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - template = "Template", + bibliography = "Bibliography", /** - * Represents that the field type is Time. + * Table-of-content heading. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - time = "Time", + tocHeading = "TocHeading", /** - * Represents that the field type is Title. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - title = "Title", + tableGrid = "TableGrid", /** - * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toa = "TOA", + plainTable1 = "PlainTable1", /** - * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toc = "TOC", + plainTable2 = "PlainTable2", /** - * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userAddress = "UserAddress", + plainTable3 = "PlainTable3", /** - * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userInitials = "UserInitials", + plainTable4 = "PlainTable4", /** - * Represents that the field type is UserName. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userName = "UserName", + plainTable5 = "PlainTable5", /** - * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - xe = "XE", + tableGridLight = "TableGridLight", /** - * Represents that the field type is Empty. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - empty = "Empty", + gridTable1Light = "GridTable1Light", /** - * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - others = "Others", + gridTable1Light_Accent1 = "GridTable1Light_Accent1", /** - * Represents that the field type is Undefined. * @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 { + gridTable1Light_Accent2 = "GridTable1Light_Accent2", /** - * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - none = "None", + gridTable1Light_Accent3 = "GridTable1Light_Accent3", /** - * 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] + * [Api set: WordApi 1.3] */ - hot = "Hot", + gridTable1Light_Accent4 = "GridTable1Light_Accent4", /** - * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - warm = "Warm", + gridTable1Light_Accent5 = "GridTable1Light_Accent5", /** - * Represents that the field doesn't have a result. * @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 { + gridTable1Light_Accent6 = "GridTable1Light_Accent6", /** - * A tab is inserted. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingTab = "TrailingTab", + gridTable2 = "GridTable2", /** - * A space is inserted. Default. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingSpace = "TrailingSpace", + gridTable2_Accent1 = "GridTable2_Accent1", /** - * 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 { + gridTable2_Accent2 = "GridTable2_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - none = "None", + gridTable2_Accent3 = "GridTable2_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic = "Arabic", + gridTable2_Accent4 = "GridTable2_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperRoman = "UpperRoman", + gridTable2_Accent5 = "GridTable2_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerRoman = "LowerRoman", + gridTable2_Accent6 = "GridTable2_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperLetter = "UpperLetter", + gridTable3 = "GridTable3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerLetter = "LowerLetter", + gridTable3_Accent1 = "GridTable3_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinal = "Ordinal", + gridTable3_Accent2 = "GridTable3_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - cardinalText = "CardinalText", + gridTable3_Accent3 = "GridTable3_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinalText = "OrdinalText", + gridTable3_Accent4 = "GridTable3_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanji = "Kanji", + gridTable3_Accent5 = "GridTable3_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiDigit = "KanjiDigit", + gridTable3_Accent6 = "GridTable3_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - aiueoHalfWidth = "AiueoHalfWidth", + gridTable4 = "GridTable4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - irohaHalfWidth = "IrohaHalfWidth", + gridTable4_Accent1 = "GridTable4_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicFullWidth = "ArabicFullWidth", + gridTable4_Accent2 = "GridTable4_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiTraditional = "KanjiTraditional", + gridTable4_Accent3 = "GridTable4_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiTraditional2 = "KanjiTraditional2", + gridTable4_Accent4 = "GridTable4_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - numberInCircle = "NumberInCircle", + gridTable4_Accent5 = "GridTable4_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - aiueo = "Aiueo", + gridTable4_Accent6 = "GridTable4_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - iroha = "Iroha", + gridTable5Dark = "GridTable5Dark", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ = "ArabicLZ", + gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - bullet = "Bullet", + gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ganada = "Ganada", + gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - chosung = "Chosung", + gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum1 = "GBNum1", + gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum2 = "GBNum2", + gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum3 = "GBNum3", + gridTable6Colorful = "GridTable6Colorful", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum4 = "GBNum4", + gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac1 = "Zodiac1", + gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac2 = "Zodiac2", + gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac3 = "Zodiac3", + gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum1 = "TradChinNum1", + gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum2 = "TradChinNum2", + gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum3 = "TradChinNum3", + gridTable7Colorful = "GridTable7Colorful", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum4 = "TradChinNum4", + gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum1 = "SimpChinNum1", + gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum2 = "SimpChinNum2", + gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum3 = "SimpChinNum3", + gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum4 = "SimpChinNum4", + gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaRead = "HanjaRead", + gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaReadDigit = "HanjaReadDigit", + listTable1Light = "ListTable1Light", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hangul = "Hangul", + listTable1Light_Accent1 = "ListTable1Light_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanja = "Hanja", + listTable1Light_Accent2 = "ListTable1Light_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew1 = "Hebrew1", + listTable1Light_Accent3 = "ListTable1Light_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic1 = "Arabic1", + listTable1Light_Accent4 = "ListTable1Light_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew2 = "Hebrew2", + listTable1Light_Accent5 = "ListTable1Light_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic2 = "Arabic2", + listTable1Light_Accent6 = "ListTable1Light_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter1 = "HindiLetter1", + listTable2 = "ListTable2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter2 = "HindiLetter2", + listTable2_Accent1 = "ListTable2_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiArabic = "HindiArabic", + listTable2_Accent2 = "ListTable2_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiCardinalText = "HindiCardinalText", + listTable2_Accent3 = "ListTable2_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiLetter = "ThaiLetter", + listTable2_Accent4 = "ListTable2_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiArabic = "ThaiArabic", + listTable2_Accent5 = "ListTable2_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiCardinalText = "ThaiCardinalText", + listTable2_Accent6 = "ListTable2_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - vietCardinalText = "VietCardinalText", + listTable3 = "ListTable3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseRussian = "LowercaseRussian", + listTable3_Accent1 = "ListTable3_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseRussian = "UppercaseRussian", + listTable3_Accent2 = "ListTable3_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseGreek = "LowercaseGreek", + listTable3_Accent3 = "ListTable3_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseGreek = "UppercaseGreek", + listTable3_Accent4 = "ListTable3_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ2 = "ArabicLZ2", + listTable3_Accent5 = "ListTable3_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ3 = "ArabicLZ3", + listTable3_Accent6 = "ListTable3_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ4 = "ArabicLZ4", + listTable4 = "ListTable4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseTurkish = "LowercaseTurkish", + listTable4_Accent1 = "ListTable4_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseTurkish = "UppercaseTurkish", + listTable4_Accent2 = "ListTable4_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseBulgarian = "LowercaseBulgarian", + listTable4_Accent3 = "ListTable4_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseBulgarian = "UppercaseBulgarian", + listTable4_Accent4 = "ListTable4_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - pictureBullet = "PictureBullet", + listTable4_Accent5 = "ListTable4_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - legal = "Legal", + listTable4_Accent6 = "ListTable4_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - 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 { + listTable5Dark = "ListTable5Dark", /** - * Represents dark diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkDiagonalDown = "DarkDiagonalDown", + listTable5Dark_Accent1 = "ListTable5Dark_Accent1", /** - * Represents dark diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkDiagonalUp = "DarkDiagonalUp", + listTable5Dark_Accent2 = "ListTable5Dark_Accent2", /** - * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkGrid = "DarkGrid", + listTable5Dark_Accent3 = "ListTable5Dark_Accent3", /** - * Represents dark horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkHorizontal = "DarkHorizontal", + listTable5Dark_Accent4 = "ListTable5Dark_Accent4", /** - * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkTrellis = "DarkTrellis", + listTable5Dark_Accent5 = "ListTable5Dark_Accent5", /** - * Represents dark vertical texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkVertical = "DarkVertical", + listTable5Dark_Accent6 = "ListTable5Dark_Accent6", /** - * Represents light diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightDiagonalDown = "LightDiagonalDown", + listTable6Colorful = "ListTable6Colorful", /** - * Represents light diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightDiagonalUp = "LightDiagonalUp", + listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", /** - * Represents light horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightGrid = "LightGrid", + listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", /** - * Represents light horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightHorizontal = "LightHorizontal", + listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", /** - * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightTrellis = "LightTrellis", + listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", /** - * Represents light vertical texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightVertical = "LightVertical", + listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", /** - * Represents that there's no texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - none = "None", + listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", /** - * Represents 10 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent10 = "Percent10", + listTable7Colorful = "ListTable7Colorful", /** - * Represents 12.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent12Pt5 = "Percent12Pt5", + listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", /** - * Represents 15 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent15 = "Percent15", + listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", /** - * Represents 20 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent20 = "Percent20", + listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", /** - * Represents 25 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent25 = "Percent25", + listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", /** - * Represents 30 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent30 = "Percent30", + listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", /** - * Represents 35 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent35 = "Percent35", + listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum DocumentPropertyType { /** - * Represents 37.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent37Pt5 = "Percent37Pt5", + string = "String", /** - * Represents 40 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent40 = "Percent40", + number = "Number", /** - * Represents 45 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent45 = "Percent45", + date = "Date", /** - * Represents 5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent5 = "Percent5", + boolean = "Boolean", + } + /** + * Represents the type of style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum StyleType { /** - * Represents 50 percent texture. + * Represents that the style is a character style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent50 = "Percent50", + character = "Character", /** - * Represents 55 percent texture. + * Represents that the style is a list style. Currently supported on desktop. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent55 = "Percent55", + list = "List", /** - * Represents 60 percent texture. + * Represents that the style is a paragraph style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent60 = "Percent60", + paragraph = "Paragraph", /** - * Represents 62.5 percent texture. + * Represents that the style is a table style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent62Pt5 = "Percent62Pt5", + table = "Table", + } + /** + * Represents the outline levels. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum OutlineLevel { /** - * Represents 65 percent texture. + * Represents outline level 1. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent65 = "Percent65", + outlineLevel1 = "OutlineLevel1", /** - * Represents 70 percent texture. + * Represents outline level 2. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent70 = "Percent70", + outlineLevel2 = "OutlineLevel2", /** - * Represents 75 percent texture. + * Represents outline level 3. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent75 = "Percent75", + outlineLevel3 = "OutlineLevel3", /** - * Represents 80 percent texture. + * Represents outline level 4. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent80 = "Percent80", + outlineLevel4 = "OutlineLevel4", /** - * Represents 85 percent texture. + * Represents outline level 5. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent85 = "Percent85", + outlineLevel5 = "OutlineLevel5", /** - * Represents 87.5 percent texture. + * Represents outline level 6. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent87Pt5 = "Percent87Pt5", + outlineLevel6 = "OutlineLevel6", /** - * Represents 90 percent texture. + * Represents outline level 7. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent90 = "Percent90", + outlineLevel7 = "OutlineLevel7", /** - * Represents 95 percent texture. + * Represents outline level 8. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent95 = "Percent95", + outlineLevel8 = "OutlineLevel8", /** - * Represents solid texture. + * Represents outline level 9. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - solid = "Solid", + outlineLevel9 = "OutlineLevel9", + /** + * Represents outline level body text, not an outline level. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevelBodyText = "OutlineLevelBodyText", } /** - * Specifies the target document for displaying document comparison differences. + * Specifies the close behavior for `Document.close`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - enum CompareTarget { - /** - * Places comparison differences in the current document. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - compareTargetCurrent = "CompareTargetCurrent", + enum CloseBehavior { /** - * Places comparison differences in the target document. + * Saves the changes before closing the document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTargetSelected = "CompareTargetSelected", + save = "Save", /** - * Places comparison differences in a new document. + * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTargetNew = "CompareTargetNew", + skipSave = "SkipSave", } /** - * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. + * Specifies the save behavior for `Document.save`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - enum ImportedStylesConflictBehavior { - /** - * Ignore conflicting imported styles and keep the existing version of those styles in the current document. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - ignore = "Ignore", + enum SaveBehavior { /** - * Overwrite the existing styles in the current document. + * 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: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - overwrite = "Overwrite", + save = "Save", /** - * 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. + * 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: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - createNew = "CreateNew", + prompt = "Prompt", } /** - * Represents the shape type. + * Represents the type of Field. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - enum ShapeType { + enum FieldType { /** - * Unsupported shape type. + * Represents that the field type is Add-in. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - unsupported = "Unsupported", + addin = "Addin", /** - * Text box shape. + * Represents that the field type is AddressBlock. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - textBox = "TextBox", + addressBlock = "AddressBlock", /** - * Geometric shape. + * Represents that the field type is Advance. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - geometricShape = "GeometricShape", + advance = "Advance", /** - * Group shape. + * Represents that the field type is Ask. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - group = "Group", + ask = "Ask", /** - * Picture shape. + * Represents that the field type is Author. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - picture = "Picture", + author = "Author", /** - * Canvas shape. + * Represents that the field type is AutoText. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - 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 { + autoText = "AutoText", /** - * Relative to margin. + * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + autoTextList = "AutoTextList", /** - * Relative to page. + * Represents that the field type is Barcode. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + barCode = "BarCode", /** - * Relative to column. + * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - column = "Column", + bibliography = "Bibliography", /** - * Relative to character. + * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - character = "Character", + bidiOutline = "BidiOutline", /** - * Relative to left margin. + * Represents that the field type is Citation. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftMargin = "LeftMargin", + citation = "Citation", /** - * Relative to right margin. + * Represents that the field type is Comments. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rightMargin = "RightMargin", + comments = "Comments", /** - * Relative to inside margin. + * Represents that the field type is Compare. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + compare = "Compare", /** - * Relative to outside margin. + * Represents that the field type is CreateDate. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - 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 { + createDate = "CreateDate", /** - * Relative to margin. + * Represents that the field type is Data. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + data = "Data", /** - * Relative to page. + * Represents that the field type is Database. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + database = "Database", /** - * Relative to paragraph. + * Represents that the field type is Date. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - paragraph = "Paragraph", + date = "Date", /** - * Relative to line. + * Represents that the field type is DisplayBarcode. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - line = "Line", + displayBarcode = "DisplayBarcode", /** - * Relative to top margin. + * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - topMargin = "TopMargin", + docProperty = "DocProperty", /** - * Relative to bottom margin. + * Represents that the field type is DocumentVariable. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bottomMargin = "BottomMargin", + docVariable = "DocVariable", /** - * Relative to inside margin. + * Represents that the field type is EditTime. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + editTime = "EditTime", /** - * Relative to outside margin. + * Represents that the field type is Embedded. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - 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 { + embedded = "Embedded", /** - * Relative to margin. + * Represents that the field type is Equation. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + eq = "EQ", /** - * Relative to page. + * Represents that the field type is Expression. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + expression = "Expression", /** - * Relative to top margin. + * Represents that the field type is FileName. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - topMargin = "TopMargin", + fileName = "FileName", /** - * Relative to bottom margin. + * Represents that the field type is FileSize. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bottomMargin = "BottomMargin", + fileSize = "FileSize", /** - * Relative to inside margin. + * Represents that the field type is FillIn. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + fillIn = "FillIn", /** - * Relative to outside margin. + * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - outsideMargin = "OutsideMargin", - } - /** - * Specifies the shape type for a `GeometricShape` object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum GeometricShapeType { + formCheckbox = "FormCheckbox", /** - * Line inverse geometric shape. + * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - lineInverse = "LineInverse", + formDropdown = "FormDropdown", /** - * Triangle geometric shape. + * Represents that the field type is FormText. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - triangle = "Triangle", + formText = "FormText", /** - * Right triangle geometric shape. + * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rightTriangle = "RightTriangle", + gotoButton = "GotoButton", /** - * Rectangle geometric shape. + * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rectangle = "Rectangle", + greetingLine = "GreetingLine", /** - * Diamond geometric shape. + * Represents that the field type is Hyperlink. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - diamond = "Diamond", + hyperlink = "Hyperlink", /** - * Parallelogram geometric shape. + * Represents that the field type is If. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - parallelogram = "Parallelogram", + if = "If", /** - * Trapezoid geometric shape. + * Represents that the field type is Import. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - trapezoid = "Trapezoid", + import = "Import", /** - * Non-isosceles trapezoid geometric shape. + * Represents that the field type is Include. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + include = "Include", /** - * Pentagon geometric shape. + * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - pentagon = "Pentagon", + includePicture = "IncludePicture", /** - * Hexagon geometric shape. + * Represents that the field type is IncludeText. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - hexagon = "Hexagon", + includeText = "IncludeText", /** - * Heptagon geometric shape. + * Represents that the field type is Index. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - heptagon = "Heptagon", + index = "Index", /** - * Octagon geometric shape. + * Represents that the field type is Information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - octagon = "Octagon", + info = "Info", /** - * Decagon geometric shape. + * Represents that the field type is Keywords. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - decagon = "Decagon", + keywords = "Keywords", /** - * Dodecagon geometric shape. + * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - dodecagon = "Dodecagon", + lastSavedBy = "LastSavedBy", /** - * Star 4-point geometric shape. + * Represents that the field type is Link. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star4 = "Star4", + link = "Link", /** - * Star 5-point geometric shape. + * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star5 = "Star5", + listNum = "ListNum", /** - * Star 6-point geometric shape. + * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star6 = "Star6", + macroButton = "MacroButton", /** - * Star 7-point geometric shape. + * Represents that the field type is MergeBarcode. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star7 = "Star7", + mergeBarcode = "MergeBarcode", /** - * Star 8-point geometric shape. + * Represents that the field type is MergeField. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star8 = "Star8", + mergeField = "MergeField", /** - * Star 10-point geometric shape. + * Represents that the field type is MergeRecord. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star10 = "Star10", + mergeRec = "MergeRec", /** - * Star 12-point geometric shape. + * Represents that the field type is MergeSequence. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star12 = "Star12", + mergeSeq = "MergeSeq", /** - * Star 16-point geometric shape. + * Represents that the field type is Next. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star16 = "Star16", + next = "Next", /** - * Star 24-point geometric shape. + * Represents that the field type is NextIf. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star24 = "Star24", + nextIf = "NextIf", /** - * Star 32-point geometric shape. + * Represents that the field type is NoteReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star32 = "Star32", + noteRef = "NoteRef", /** - * Round rectangle geometric shape. + * Represents that the field type is NumberOfCharacters. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - roundRectangle = "RoundRectangle", + numChars = "NumChars", /** - * Round one rectangle geometric shape. + * Represents that the field type is NumberOfPages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - round1Rectangle = "Round1Rectangle", + numPages = "NumPages", /** - * Round two same rectangle geometric shape. + * Represents that the field type is NumberOfWords. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - round2SameRectangle = "Round2SameRectangle", + numWords = "NumWords", /** - * Round two diagonal rectangle geometric shape. + * Represents that the field type is ActiveXControl. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - round2DiagonalRectangle = "Round2DiagonalRectangle", + ocx = "OCX", /** - * Snip round rectangle geometric shape. + * Represents that the field type is Page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - snipRoundRectangle = "SnipRoundRectangle", + page = "Page", /** - * Snip one rectangle geometric shape. + * Represents that the field type is PageReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - snip1Rectangle = "Snip1Rectangle", + pageRef = "PageRef", /** - * Snip two same rectangle geometric shape. + * Represents that the field type is Print. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - snip2SameRectangle = "Snip2SameRectangle", + print = "Print", /** - * Snip two diagonal rectangle geometric shape. + * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - snip2DiagonalRectangle = "Snip2DiagonalRectangle", + printDate = "PrintDate", /** - * Plaque geometric shape. + * Represents that the field type is Private. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - plaque = "Plaque", + private = "Private", /** - * Ellipse geometric shape. + * Represents that the field type is Quote. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - ellipse = "Ellipse", + quote = "Quote", /** - * Teardrop geometric shape. + * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - teardrop = "Teardrop", + rd = "RD", /** - * Home plate geometric shape. + * Represents that the field type is Reference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - homePlate = "HomePlate", + ref = "Ref", /** - * Chevron geometric shape. + * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - chevron = "Chevron", + revNum = "RevNum", /** - * Pie wedge geometric shape. + * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - pieWedge = "PieWedge", + saveDate = "SaveDate", /** - * Pie geometric shape. + * Represents that the field type is Section. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - pie = "Pie", + section = "Section", /** - * Block arc geometric shape. + * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - blockArc = "BlockArc", + sectionPages = "SectionPages", /** - * Donut geometric shape. + * Represents that the field type is Sequence. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - donut = "Donut", + seq = "Seq", /** - * No smoking geometric shape. + * Represents that the field type is Set. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - noSmoking = "NoSmoking", + set = "Set", /** - * Right arrow geometric shape. + * Represents that the field type is Shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rightArrow = "RightArrow", + shape = "Shape", /** - * Left arrow geometric shape. + * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftArrow = "LeftArrow", + skipIf = "SkipIf", /** - * Up arrow geometric shape. + * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - upArrow = "UpArrow", + styleRef = "StyleRef", /** - * Down arrow geometric shape. + * Represents that the field type is Subject. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - downArrow = "DownArrow", + subject = "Subject", /** - * Striped right arrow geometric shape. + * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - stripedRightArrow = "StripedRightArrow", + subscriber = "Subscriber", /** - * Notched right arrow geometric shape. + * Represents that the field type is Symbol. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - notchedRightArrow = "NotchedRightArrow", + symbol = "Symbol", /** - * Bent up arrow geometric shape. + * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bentUpArrow = "BentUpArrow", + ta = "TA", /** - * Left-right arrow geometric shape. + * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftRightArrow = "LeftRightArrow", + tc = "TC", /** - * Up-down arrow geometric shape. + * Represents that the field type is Template. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - upDownArrow = "UpDownArrow", + template = "Template", /** - * Left-up arrow geometric shape. + * Represents that the field type is Time. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftUpArrow = "LeftUpArrow", + time = "Time", /** - * Left-right-up arrow geometric shape. + * Represents that the field type is Title. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftRightUpArrow = "LeftRightUpArrow", + title = "Title", /** - * Quad arrow geometric shape. + * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - quadArrow = "QuadArrow", + toa = "TOA", /** - * Left arrow callout geometric shape. + * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftArrowCallout = "LeftArrowCallout", + toc = "TOC", /** - * Right arrow callout geometric shape. + * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rightArrowCallout = "RightArrowCallout", + userAddress = "UserAddress", /** - * Up arrow callout geometric shape. + * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - upArrowCallout = "UpArrowCallout", + userInitials = "UserInitials", /** - * Down arrow callout geometric shape. + * Represents that the field type is UserName. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - downArrowCallout = "DownArrowCallout", + userName = "UserName", /** - * Left-right arrow callout geometric shape. + * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftRightArrowCallout = "LeftRightArrowCallout", + xe = "XE", /** - * Up-down arrow callout geometric shape. + * Represents that the field type is Empty. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - upDownArrowCallout = "UpDownArrowCallout", + empty = "Empty", /** - * Quad arrow callout geometric shape. + * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - quadArrowCallout = "QuadArrowCallout", + others = "Others", /** - * Bent arrow geometric shape. + * Represents that the field type is Undefined. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bentArrow = "BentArrow", + undefined = "Undefined", + } + /** + * Represents the kind of field. Indicates how the field works in relation to updating. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldKind { /** - * U-turn arrow geometric shape. + * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - uturnArrow = "UturnArrow", + none = "None", /** - * Circular arrow geometric shape. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - circularArrow = "CircularArrow", + hot = "Hot", /** - * Left circular arrow geometric shape. + * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftCircularArrow = "LeftCircularArrow", + warm = "Warm", /** - * Left-right circular arrow geometric shape. + * Represents that the field doesn't have a result. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftRightCircularArrow = "LeftRightCircularArrow", + cold = "Cold", + } + /** + * Represents the character inserted after the list item mark. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum TrailingCharacter { /** - * Curved right arrow geometric shape. + * A tab is inserted. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedRightArrow = "CurvedRightArrow", + trailingTab = "TrailingTab", /** - * Curved left arrow geometric shape. + * A space is inserted. Default. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedLeftArrow = "CurvedLeftArrow", + trailingSpace = "TrailingSpace", /** - * Curved up arrow geometric shape. + * No character is inserted. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedUpArrow = "CurvedUpArrow", + trailingNone = "TrailingNone", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ListBuiltInNumberStyle { /** - * Curved down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedDownArrow = "CurvedDownArrow", + none = "None", /** - * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - swooshArrow = "SwooshArrow", + arabic = "Arabic", /** - * Cube geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cube = "Cube", + upperRoman = "UpperRoman", /** - * Can geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - can = "Can", + lowerRoman = "LowerRoman", /** - * Lightning bolt geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - lightningBolt = "LightningBolt", + upperLetter = "UpperLetter", /** - * Heart geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - heart = "Heart", + lowerLetter = "LowerLetter", /** - * Sun geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - sun = "Sun", + ordinal = "Ordinal", /** - * Moon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - moon = "Moon", + cardinalText = "CardinalText", /** - * Smiley face geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - smileyFace = "SmileyFace", + ordinalText = "OrdinalText", /** - * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - irregularSeal1 = "IrregularSeal1", + kanji = "Kanji", /** - * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - irregularSeal2 = "IrregularSeal2", + kanjiDigit = "KanjiDigit", /** - * Folded corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - foldedCorner = "FoldedCorner", + aiueoHalfWidth = "AiueoHalfWidth", /** - * Bevel geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bevel = "Bevel", + irohaHalfWidth = "IrohaHalfWidth", /** - * Frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - frame = "Frame", + arabicFullWidth = "ArabicFullWidth", /** - * Half frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - halfFrame = "HalfFrame", + kanjiTraditional = "KanjiTraditional", /** - * Corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - corner = "Corner", + kanjiTraditional2 = "KanjiTraditional2", /** - * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - diagonalStripe = "DiagonalStripe", + numberInCircle = "NumberInCircle", /** - * Chord geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - chord = "Chord", + aiueo = "Aiueo", /** - * Arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - arc = "Arc", + iroha = "Iroha", /** - * Left bracket geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftBracket = "LeftBracket", + arabicLZ = "ArabicLZ", /** - * Right bracket geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightBracket = "RightBracket", + bullet = "Bullet", /** - * Left brace geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftBrace = "LeftBrace", + ganada = "Ganada", /** - * Right brace geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightBrace = "RightBrace", + chosung = "Chosung", /** - * Bracket pair geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bracketPair = "BracketPair", + gbnum1 = "GBNum1", /** - * Brace pair geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bracePair = "BracePair", + gbnum2 = "GBNum2", /** - * Callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout1 = "Callout1", + gbnum3 = "GBNum3", /** - * Callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout2 = "Callout2", + gbnum4 = "GBNum4", /** - * Callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout3 = "Callout3", + zodiac1 = "Zodiac1", /** - * Accent callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout1 = "AccentCallout1", + zodiac2 = "Zodiac2", /** - * Accent callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout2 = "AccentCallout2", + zodiac3 = "Zodiac3", /** - * Accent callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout3 = "AccentCallout3", + tradChinNum1 = "TradChinNum1", /** - * Border callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout1 = "BorderCallout1", + tradChinNum2 = "TradChinNum2", /** - * Border callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout2 = "BorderCallout2", + tradChinNum3 = "TradChinNum3", /** - * Border callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout3 = "BorderCallout3", + tradChinNum4 = "TradChinNum4", /** - * Accent border callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout1 = "AccentBorderCallout1", + simpChinNum1 = "SimpChinNum1", /** - * Accent border callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout2 = "AccentBorderCallout2", + simpChinNum2 = "SimpChinNum2", /** - * Accent border callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout3 = "AccentBorderCallout3", + simpChinNum3 = "SimpChinNum3", /** - * Wedge rectangle callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeRectCallout = "WedgeRectCallout", + simpChinNum4 = "SimpChinNum4", /** - * Wedge rounded rectangle callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeRRectCallout = "WedgeRRectCallout", + hanjaRead = "HanjaRead", /** - * Wedge ellipse callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeEllipseCallout = "WedgeEllipseCallout", + hanjaReadDigit = "HanjaReadDigit", /** - * Cloud callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cloudCallout = "CloudCallout", + hangul = "Hangul", /** - * Cloud geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cloud = "Cloud", + hanja = "Hanja", /** - * Ribbon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ribbon = "Ribbon", + hebrew1 = "Hebrew1", /** - * Ribbon 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ribbon2 = "Ribbon2", + arabic1 = "Arabic1", /** - * Ellipse ribbon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ellipseRibbon = "EllipseRibbon", + hebrew2 = "Hebrew2", /** - * Ellipse ribbon 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ellipseRibbon2 = "EllipseRibbon2", + arabic2 = "Arabic2", /** - * Left-right ribbon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightRibbon = "LeftRightRibbon", + hindiLetter1 = "HindiLetter1", /** - * Vertical scroll geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - verticalScroll = "VerticalScroll", + hindiLetter2 = "HindiLetter2", /** - * Horizontal scroll geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - horizontalScroll = "HorizontalScroll", + hindiArabic = "HindiArabic", /** - * Wave geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wave = "Wave", + hindiCardinalText = "HindiCardinalText", /** - * Double wave geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - doubleWave = "DoubleWave", + thaiLetter = "ThaiLetter", /** - * Plus geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - plus = "Plus", + thaiArabic = "ThaiArabic", /** - * Flow chart process geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartProcess = "FlowChartProcess", + thaiCardinalText = "ThaiCardinalText", /** - * Flow chart decision geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartDecision = "FlowChartDecision", + vietCardinalText = "VietCardinalText", /** - * Flow chart input-output geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartInputOutput = "FlowChartInputOutput", + lowercaseRussian = "LowercaseRussian", /** - * Flow chart predefined process geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPredefinedProcess = "FlowChartPredefinedProcess", + uppercaseRussian = "UppercaseRussian", /** - * Flow chart internal storage geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartInternalStorage = "FlowChartInternalStorage", + lowercaseGreek = "LowercaseGreek", /** - * Flow chart document geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartDocument = "FlowChartDocument", + uppercaseGreek = "UppercaseGreek", /** - * Flow chart multidocument geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMultidocument = "FlowChartMultidocument", + arabicLZ2 = "ArabicLZ2", /** - * Flow chart terminator geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartTerminator = "FlowChartTerminator", + arabicLZ3 = "ArabicLZ3", /** - * Flow chart preparation geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPreparation = "FlowChartPreparation", + arabicLZ4 = "ArabicLZ4", /** - * Flow chart manual input geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartManualInput = "FlowChartManualInput", + lowercaseTurkish = "LowercaseTurkish", /** - * Flow chart manual operation geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartManualOperation = "FlowChartManualOperation", + uppercaseTurkish = "UppercaseTurkish", /** - * Flow chart connector geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartConnector = "FlowChartConnector", + lowercaseBulgarian = "LowercaseBulgarian", /** - * Flow chart punched card geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPunchedCard = "FlowChartPunchedCard", + uppercaseBulgarian = "UppercaseBulgarian", /** - * Flow chart punched tape geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPunchedTape = "FlowChartPunchedTape", + pictureBullet = "PictureBullet", /** - * Flow chart summing junction geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartSummingJunction = "FlowChartSummingJunction", + legal = "Legal", /** - * Flow chart OR geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartOr = "FlowChartOr", + 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 { /** - * Flow chart collate geometric shape. + * Represents dark diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartCollate = "FlowChartCollate", + darkDiagonalDown = "DarkDiagonalDown", /** - * Flow chart sort geometric shape. + * Represents dark diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartSort = "FlowChartSort", + darkDiagonalUp = "DarkDiagonalUp", /** - * Flow chart extract geometric shape. + * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartExtract = "FlowChartExtract", + darkGrid = "DarkGrid", /** - * Flow chart merge geometric shape. + * Represents dark horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMerge = "FlowChartMerge", + darkHorizontal = "DarkHorizontal", /** - * Flow chart offline storage geometric shape. + * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartOfflineStorage = "FlowChartOfflineStorage", + darkTrellis = "DarkTrellis", /** - * Flow chart online storage geometric shape. + * Represents dark vertical texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartOnlineStorage = "FlowChartOnlineStorage", + darkVertical = "DarkVertical", /** - * Flow chart magnetic tape geometric shape. + * Represents light diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMagneticTape = "FlowChartMagneticTape", + lightDiagonalDown = "LightDiagonalDown", /** - * Flow chart magnetic disk geometric shape. + * Represents light diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMagneticDisk = "FlowChartMagneticDisk", + lightDiagonalUp = "LightDiagonalUp", /** - * Flow chart magnetic drum geometric shape. + * Represents light horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMagneticDrum = "FlowChartMagneticDrum", + lightGrid = "LightGrid", /** - * Flow chart display geometric shape. + * Represents light horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartDisplay = "FlowChartDisplay", + lightHorizontal = "LightHorizontal", /** - * Flow chart delay geometric shape. + * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartDelay = "FlowChartDelay", + lightTrellis = "LightTrellis", /** - * Flow chart alternate process geometric shape. + * Represents light vertical texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartAlternateProcess = "FlowChartAlternateProcess", + lightVertical = "LightVertical", /** - * Flow chart off-page connector geometric shape. + * Represents that there's no texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartOffpageConnector = "FlowChartOffpageConnector", + none = "None", /** - * Action button blank geometric shape. + * Represents 10 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonBlank = "ActionButtonBlank", + percent10 = "Percent10", /** - * Action button home geometric shape. + * Represents 12.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonHome = "ActionButtonHome", + percent12Pt5 = "Percent12Pt5", /** - * Action button help geometric shape. + * Represents 15 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonHelp = "ActionButtonHelp", + percent15 = "Percent15", /** - * Action button information geometric shape. + * Represents 20 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonInformation = "ActionButtonInformation", + percent20 = "Percent20", /** - * Action button forward next geometric shape. + * Represents 25 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonForwardNext = "ActionButtonForwardNext", + percent25 = "Percent25", /** - * Action button back previous geometric shape. + * Represents 30 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonBackPrevious = "ActionButtonBackPrevious", + percent30 = "Percent30", /** - * Action button end geometric shape. + * Represents 35 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonEnd = "ActionButtonEnd", + percent35 = "Percent35", /** - * Action button beginning geometric shape. + * Represents 37.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonBeginning = "ActionButtonBeginning", + percent37Pt5 = "Percent37Pt5", /** - * Action button return geometric shape. + * Represents 40 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonReturn = "ActionButtonReturn", + percent40 = "Percent40", /** - * Action button document geometric shape. + * Represents 45 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonDocument = "ActionButtonDocument", + percent45 = "Percent45", /** - * Action button sound geometric shape. + * Represents 5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonSound = "ActionButtonSound", + percent5 = "Percent5", /** - * Action button movie geometric shape. + * Represents 50 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - actionButtonMovie = "ActionButtonMovie", + percent50 = "Percent50", /** - * Gear 6 geometric shape. + * Represents 55 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - gear6 = "Gear6", + percent55 = "Percent55", /** - * Gear 9 geometric shape. + * Represents 60 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - gear9 = "Gear9", + percent60 = "Percent60", /** - * Funnel geometric shape. + * Represents 62.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - funnel = "Funnel", + percent62Pt5 = "Percent62Pt5", /** - * Math plus geometric shape. + * Represents 65 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - mathPlus = "MathPlus", + percent65 = "Percent65", /** - * Math minus geometric shape. + * Represents 70 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - mathMinus = "MathMinus", + percent70 = "Percent70", /** - * Math multiply geometric shape. + * Represents 75 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - mathMultiply = "MathMultiply", + percent75 = "Percent75", /** - * Math divide geometric shape. + * Represents 80 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - mathDivide = "MathDivide", + percent80 = "Percent80", /** - * Math equal geometric shape. + * Represents 85 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - mathEqual = "MathEqual", + percent85 = "Percent85", /** - * Math not equal geometric shape. + * Represents 87.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - mathNotEqual = "MathNotEqual", + percent87Pt5 = "Percent87Pt5", /** - * Corner tabs geometric shape. + * Represents 90 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cornerTabs = "CornerTabs", + percent90 = "Percent90", /** - * Square tabs geometric shape. + * Represents 95 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - squareTabs = "SquareTabs", + percent95 = "Percent95", /** - * Plaque tabs geometric shape. + * Represents solid texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - plaqueTabs = "PlaqueTabs", + solid = "Solid", + } + /** + * Specifies the target document for displaying document comparison differences. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum CompareTarget { /** - * Chart X geometric shape. + * Places comparison differences in the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - chartX = "ChartX", + compareTargetCurrent = "CompareTargetCurrent", /** - * Chart star geometric shape. + * Places comparison differences in the target document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - chartStar = "ChartStar", + compareTargetSelected = "CompareTargetSelected", /** - * Chart plus geometric shape. + * Places comparison differences in a new document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - chartPlus = "ChartPlus", + compareTargetNew = "CompareTargetNew", } /** - * Specifies a shape's fill type. + * 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.2] + * [Api set: WordApiDesktop 1.1] */ - enum ShapeFillType { + enum ImportedStylesConflictBehavior { /** - * No fill. + * Ignore conflicting imported styles and keep the existing version of those styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - noFill = "NoFill", + ignore = "Ignore", /** - * Solid fill. + * Overwrite the existing styles in the current document. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + overwrite = "Overwrite", + /** + * 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] + */ + createNew = "CreateNew", + } + /** + * Represents the shape type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeType { + /** + * Unsupported shape type. * @remarks * [Api set: WordApiDesktop 1.2] */ - solid = "Solid", + unsupported = "Unsupported", /** - * Gradient fill. + * Text box shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - gradient = "Gradient", + textBox = "TextBox", /** - * Pattern fill. + * Geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - pattern = "Pattern", + geometricShape = "GeometricShape", /** - * Picture fill. + * Group shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - picture = "Picture", + group = "Group", /** - * Texture fill. + * Picture shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - texture = "Texture", + picture = "Picture", /** - * Mixed fill. + * Canvas shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + canvas = "Canvas", } /** - * Specifies the vertical alignment for the text frame in a shape. + * 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 ShapeTextVerticalAlignment { + enum RelativeHorizontalPosition { /** - * Anchor the text at the top of the bounding rectangle. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - top = "Top", + margin = "Margin", /** - * Anchor the text at the middle of the bounding rectangle. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - middle = "Middle", + page = "Page", /** - * Anchor the text at the bottom of the bounding rectangle. + * Relative to column. * @remarks * [Api set: WordApiDesktop 1.2] */ - bottom = "Bottom", + column = "Column", + /** + * Relative to character. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + character = "Character", + /** + * Relative to left margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftMargin = "LeftMargin", + /** + * Relative to right margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rightMargin = "RightMargin", + /** + * Relative to inside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + outsideMargin = "OutsideMargin", } /** - * Specifies the orientation for the text frame in a shape. + * 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 ShapeTextOrientation { + enum RelativeVerticalPosition { /** - * No orientation, such as in a new geometric shape. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + margin = "Margin", /** - * Horizontal text. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - horizontal = "Horizontal", + page = "Page", /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * Relative to paragraph. * @remarks * [Api set: WordApiDesktop 1.2] */ - eastAsianVertical = "EastAsianVertical", + paragraph = "Paragraph", /** - * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). + * Relative to line. * @remarks * [Api set: WordApiDesktop 1.2] */ - vertical270 = "Vertical270", + line = "Line", /** - * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). + * Relative to top margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - vertical = "Vertical", + topMargin = "TopMargin", /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * Relative to bottom margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - eastAsianHorizontalRotated = "EastAsianHorizontalRotated", + bottomMargin = "BottomMargin", /** - * A combination of automatic orientation is used. + * Relative to inside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + outsideMargin = "OutsideMargin", } /** - * Determines the type of automatic sizing allowed. + * 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 ShapeAutoSize { + enum RelativeSize { /** - * No autosizing. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + margin = "Margin", /** - * The text is adjusted to fit the shape. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - textToFitShape = "TextToFitShape", + page = "Page", /** - * The shape is adjusted to fit the text. + * Relative to top margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - shapeToFitText = "ShapeToFitText", + topMargin = "TopMargin", /** - * A combination of automatic sizing schemes are used. + * Relative to bottom margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + bottomMargin = "BottomMargin", + /** + * Relative to inside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + outsideMargin = "OutsideMargin", } /** - * 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}. + * Specifies the shape type for a `GeometricShape` object. * * @remarks * [Api set: WordApiDesktop 1.2] */ - enum ShapeTextWrapType { + enum GeometricShapeType { /** - * Places the shape in line with text. + * Line inverse geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - inline = "Inline", + lineInverse = "LineInverse", /** - * Wraps text squarely around the shape. + * Triangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - square = "Square", + triangle = "Triangle", /** - * Wraps text close to the shape. + * Right triangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - tight = "Tight", + rightTriangle = "RightTriangle", /** - * Wraps text around and through the shape. + * Rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - through = "Through", + rectangle = "Rectangle", /** - * Places text above and below the shape. + * Diamond geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - topBottom = "TopBottom", + diamond = "Diamond", /** - * Places shape behind text. + * Parallelogram geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - behind = "Behind", + parallelogram = "Parallelogram", /** - * Places shape in front of text. + * Trapezoid geometric shape. * @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 { + trapezoid = "Trapezoid", /** - * Has no wrap side property, such as those for inline shapes. + * Non-isosceles trapezoid geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", /** - * Both left and right sides of the shape. + * Pentagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - both = "Both", + pentagon = "Pentagon", /** - * Left side of the shape only. + * Hexagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - left = "Left", + hexagon = "Hexagon", /** - * Right side of the shape only. + * Heptagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - right = "Right", + heptagon = "Heptagon", /** - * Side of the shape that's farther from the respective page margin. + * Octagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - largest = "Largest", - } - /** - * Specifies the scale size type of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeScaleType { + octagon = "Octagon", /** - * Scale from current size of the shape. + * Decagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - currentSize = "CurrentSize", + decagon = "Decagon", /** - * Scale from original size of the shape. It only works for pictures. + * Dodecagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - originalSize = "OriginalSize", - } - /** - * Specifies which part of the shape retains its position when the shape is scaled. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeScaleFrom { + dodecagon = "Dodecagon", /** - * Scale from the top left corner of the shape. + * Star 4-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromTopLeft = "ScaleFromTopLeft", + star4 = "Star4", /** - * Scale from the center of the shape. + * Star 5-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromMiddle = "ScaleFromMiddle", + star5 = "Star5", /** - * Scale from the bottom right corner of the shape. + * Star 6-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromBottomRight = "ScaleFromBottomRight", - } - /** - * Represents the language ID of a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LanguageId { + star6 = "Star6", /** - * Afrikaans language. + * Star 7-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - afrikaans = "Afrikaans", + star7 = "Star7", /** - * Albanian language. + * Star 8-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - albanian = "Albanian", + star8 = "Star8", /** - * Amharic language. + * Star 10-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - amharic = "Amharic", + star10 = "Star10", /** - * Arabic language. + * Star 12-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabic = "Arabic", + star12 = "Star12", /** - * Arabic Algerian language. + * Star 16-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicAlgeria = "ArabicAlgeria", + star16 = "Star16", /** - * Arabic Bahraini language. + * Star 24-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicBahrain = "ArabicBahrain", + star24 = "Star24", /** - * Arabic Egyptian language. + * Star 32-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicEgypt = "ArabicEgypt", + star32 = "Star32", /** - * Arabic Iraqi language. + * Round rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicIraq = "ArabicIraq", + roundRectangle = "RoundRectangle", /** - * Arabic Jordanian language. + * Round one rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicJordan = "ArabicJordan", + round1Rectangle = "Round1Rectangle", /** - * Arabic Kuwaiti language. + * Round two same rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicKuwait = "ArabicKuwait", + round2SameRectangle = "Round2SameRectangle", /** - * Arabic Lebanese language. + * Round two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicLebanon = "ArabicLebanon", + round2DiagonalRectangle = "Round2DiagonalRectangle", /** - * Arabic Libyan language. + * Snip round rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicLibya = "ArabicLibya", + snipRoundRectangle = "SnipRoundRectangle", /** - * Arabic Moroccan language. + * Snip one rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicMorocco = "ArabicMorocco", + snip1Rectangle = "Snip1Rectangle", /** - * Arabic Omani language. + * Snip two same rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicOman = "ArabicOman", + snip2SameRectangle = "Snip2SameRectangle", /** - * Arabic Qatari language. + * Snip two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicQatar = "ArabicQatar", + snip2DiagonalRectangle = "Snip2DiagonalRectangle", /** - * Arabic Syrian language. + * Plaque geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicSyria = "ArabicSyria", + plaque = "Plaque", /** - * Arabic Tunisian language. + * Ellipse geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicTunisia = "ArabicTunisia", + ellipse = "Ellipse", /** - * Arabic United Arab Emirates language. + * Teardrop geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicUAE = "ArabicUAE", + teardrop = "Teardrop", /** - * Arabic Yemeni language. + * Home plate geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabicYemen = "ArabicYemen", + homePlate = "HomePlate", /** - * Armenian language. + * Chevron geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - armenian = "Armenian", + chevron = "Chevron", /** - * Assamese language. + * Pie wedge geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - assamese = "Assamese", + pieWedge = "PieWedge", /** - * Azerbaijani Cyrillic language. + * Pie geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - azeriCyrillic = "AzeriCyrillic", + pie = "Pie", /** - * Azerbaijani Latin language. + * Block arc geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - azeriLatin = "AzeriLatin", + blockArc = "BlockArc", /** - * Basque (Basque). + * Donut geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - basque = "Basque", + donut = "Donut", /** - * Belgian Dutch language. + * No smoking geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - belgianDutch = "BelgianDutch", + noSmoking = "NoSmoking", /** - * Belgian French language. + * Right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - belgianFrench = "BelgianFrench", + rightArrow = "RightArrow", /** - * Bengali language. + * Left arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bengali = "Bengali", + leftArrow = "LeftArrow", /** - * Bulgarian language. + * Up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bulgarian = "Bulgarian", + upArrow = "UpArrow", /** - * Burmese language. + * Down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - burmese = "Burmese", + downArrow = "DownArrow", /** - * Belarusian language. + * Striped right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - belarusian = "Belarusian", + stripedRightArrow = "StripedRightArrow", /** - * Catalan language. + * Notched right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - catalan = "Catalan", + notchedRightArrow = "NotchedRightArrow", /** - * Cherokee language. + * Bent up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cherokee = "Cherokee", + bentUpArrow = "BentUpArrow", /** - * Chinese Hong Kong SAR language. + * Left-right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - chineseHongKongSAR = "ChineseHongKongSAR", + leftRightArrow = "LeftRightArrow", /** - * Chinese Macao SAR language. + * Up-down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - chineseMacaoSAR = "ChineseMacaoSAR", + upDownArrow = "UpDownArrow", /** - * Chinese Singapore language. + * Left-up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - chineseSingapore = "ChineseSingapore", + leftUpArrow = "LeftUpArrow", /** - * Croatian language. + * Left-right-up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - croatian = "Croatian", + leftRightUpArrow = "LeftRightUpArrow", /** - * Czech language. + * Quad arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - czech = "Czech", + quadArrow = "QuadArrow", /** - * Danish language. + * Left arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - danish = "Danish", + leftArrowCallout = "LeftArrowCallout", /** - * Divehi language. + * Right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - divehi = "Divehi", + rightArrowCallout = "RightArrowCallout", /** - * Dutch language. + * Up arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dutch = "Dutch", + upArrowCallout = "UpArrowCallout", /** - * Edo language. + * Down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - edo = "Edo", + downArrowCallout = "DownArrowCallout", /** - * Australian English language. + * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishAUS = "EnglishAUS", + leftRightArrowCallout = "LeftRightArrowCallout", /** - * Belize English language. + * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishBelize = "EnglishBelize", + upDownArrowCallout = "UpDownArrowCallout", /** - * Canadian English language. + * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishCanadian = "EnglishCanadian", + quadArrowCallout = "QuadArrowCallout", /** - * Caribbean English language. + * Bent arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishCaribbean = "EnglishCaribbean", + bentArrow = "BentArrow", /** - * Indonesian English language. + * U-turn arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishIndonesia = "EnglishIndonesia", + uturnArrow = "UturnArrow", /** - * Irish English language. + * Circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishIreland = "EnglishIreland", + circularArrow = "CircularArrow", /** - * Jamaican English language. + * Left circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishJamaica = "EnglishJamaica", + leftCircularArrow = "LeftCircularArrow", /** - * New Zealand English language. + * Left-right circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishNewZealand = "EnglishNewZealand", + leftRightCircularArrow = "LeftRightCircularArrow", /** - * Filipino English language. + * Curved right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishPhilippines = "EnglishPhilippines", + curvedRightArrow = "CurvedRightArrow", /** - * South African English language. + * Curved left arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishSouthAfrica = "EnglishSouthAfrica", + curvedLeftArrow = "CurvedLeftArrow", /** - * Tobago Trinidad English language. + * Curved up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishTrinidadTobago = "EnglishTrinidadTobago", + curvedUpArrow = "CurvedUpArrow", /** - * United Kingdom English language. + * Curved down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishUK = "EnglishUK", + curvedDownArrow = "CurvedDownArrow", /** - * United States English language. + * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishUS = "EnglishUS", + swooshArrow = "SwooshArrow", /** - * Zimbabwe English language. + * Cube geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - englishZimbabwe = "EnglishZimbabwe", + cube = "Cube", /** - * Estonian language. + * Can geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - estonian = "Estonian", + can = "Can", /** - * Faeroese language. + * Lightning bolt geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - faeroese = "Faeroese", + lightningBolt = "LightningBolt", /** - * Filipino language. + * Heart geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - filipino = "Filipino", + heart = "Heart", /** - * Finnish language. + * Sun geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - finnish = "Finnish", + sun = "Sun", /** - * French language. + * Moon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - french = "French", + moon = "Moon", /** - * French Cameroon language. + * Smiley face geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchCameroon = "FrenchCameroon", + smileyFace = "SmileyFace", /** - * French Canadian language. + * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchCanadian = "FrenchCanadian", + irregularSeal1 = "IrregularSeal1", /** - * French (Congo (DRC)) language. + * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchCongoDRC = "FrenchCongoDRC", + irregularSeal2 = "IrregularSeal2", /** - * French Cote d'Ivoire language. + * Folded corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchCotedIvoire = "FrenchCotedIvoire", + foldedCorner = "FoldedCorner", /** - * French Haiti language. + * Bevel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchHaiti = "FrenchHaiti", + bevel = "Bevel", /** - * French Luxembourg language. + * Frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchLuxembourg = "FrenchLuxembourg", + frame = "Frame", /** - * French Mali language. + * Half frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchMali = "FrenchMali", + halfFrame = "HalfFrame", /** - * French Monaco language. + * Corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchMonaco = "FrenchMonaco", + corner = "Corner", /** - * French Morocco language. + * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchMorocco = "FrenchMorocco", + diagonalStripe = "DiagonalStripe", /** - * French Reunion language. + * Chord geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchReunion = "FrenchReunion", + chord = "Chord", /** - * French Senegal language. + * Arc geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchSenegal = "FrenchSenegal", + arc = "Arc", /** - * French West Indies language. + * Left bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frenchWestIndies = "FrenchWestIndies", + leftBracket = "LeftBracket", /** - * Frisian Netherlands language. + * Right bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frisianNetherlands = "FrisianNetherlands", + rightBracket = "RightBracket", /** - * Fulfulde language. + * Left brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - fulfulde = "Fulfulde", + leftBrace = "LeftBrace", /** - * Irish (Irish) language. + * Right brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gaelicIreland = "GaelicIreland", + rightBrace = "RightBrace", /** - * Scottish Gaelic language. + * Bracket pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gaelicScotland = "GaelicScotland", + bracketPair = "BracketPair", /** - * Galician language. + * Brace pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - galician = "Galician", + bracePair = "BracePair", /** - * Georgian language. + * Callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - georgian = "Georgian", + callout1 = "Callout1", /** - * German language. + * Callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - german = "German", + callout2 = "Callout2", /** - * German Austrian language. + * Callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - germanAustria = "GermanAustria", + callout3 = "Callout3", /** - * German Liechtenstein language. + * Accent callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - germanLiechtenstein = "GermanLiechtenstein", + accentCallout1 = "AccentCallout1", /** - * German Luxembourg language. + * Accent callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - germanLuxembourg = "GermanLuxembourg", + accentCallout2 = "AccentCallout2", /** - * Greek language. + * Accent callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - greek = "Greek", + accentCallout3 = "AccentCallout3", /** - * Guarani language. + * Border callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - guarani = "Guarani", + borderCallout1 = "BorderCallout1", /** - * Gujarati language. + * Border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gujarati = "Gujarati", + borderCallout2 = "BorderCallout2", /** - * Hausa language. + * Border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hausa = "Hausa", + borderCallout3 = "BorderCallout3", /** - * Hawaiian language. + * Accent border callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hawaiian = "Hawaiian", + accentBorderCallout1 = "AccentBorderCallout1", /** - * Hebrew language. + * Accent border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hebrew = "Hebrew", + accentBorderCallout2 = "AccentBorderCallout2", /** - * Hindi language. + * Accent border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hindi = "Hindi", + accentBorderCallout3 = "AccentBorderCallout3", /** - * Hungarian language. + * Wedge rectangle callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hungarian = "Hungarian", + wedgeRectCallout = "WedgeRectCallout", /** - * Ibibio language. + * Wedge rounded rectangle callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - ibibio = "Ibibio", + wedgeRRectCallout = "WedgeRRectCallout", /** - * Icelandic language. + * Wedge ellipse callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - icelandic = "Icelandic", + wedgeEllipseCallout = "WedgeEllipseCallout", /** - * Igbo language. + * Cloud callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - igbo = "Igbo", + cloudCallout = "CloudCallout", /** - * Indonesian language. + * Cloud geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - indonesian = "Indonesian", + cloud = "Cloud", /** - * Inuktitut language. + * Ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - inuktitut = "Inuktitut", + ribbon = "Ribbon", /** - * Italian language. + * Ribbon 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - italian = "Italian", + ribbon2 = "Ribbon2", /** - * Japanese language. + * Ellipse ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - japanese = "Japanese", + ellipseRibbon = "EllipseRibbon", /** - * Kannada language. + * Ellipse ribbon 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kannada = "Kannada", + ellipseRibbon2 = "EllipseRibbon2", /** - * Kanuri language. + * Left-right ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kanuri = "Kanuri", + leftRightRibbon = "LeftRightRibbon", /** - * Kashmiri language. + * Vertical scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kashmiri = "Kashmiri", + verticalScroll = "VerticalScroll", /** - * Kazakh language. + * Horizontal scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kazakh = "Kazakh", + horizontalScroll = "HorizontalScroll", /** - * Khmer language. + * Wave geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - khmer = "Khmer", + wave = "Wave", /** - * Kirghiz language. + * Double wave geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kirghiz = "Kirghiz", + doubleWave = "DoubleWave", /** - * Konkani language. + * Plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - konkani = "Konkani", + plus = "Plus", /** - * Korean language. + * Flow chart process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - korean = "Korean", + flowChartProcess = "FlowChartProcess", /** - * Kyrgyz language. + * Flow chart decision geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kyrgyz = "Kyrgyz", + flowChartDecision = "FlowChartDecision", /** - * No specified language. + * Flow chart input-output geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageNone = "LanguageNone", + flowChartInputOutput = "FlowChartInputOutput", /** - * Lao language. + * Flow chart predefined process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lao = "Lao", + flowChartPredefinedProcess = "FlowChartPredefinedProcess", /** - * Latin language. + * Flow chart internal storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - latin = "Latin", + flowChartInternalStorage = "FlowChartInternalStorage", /** - * Latvian language. + * Flow chart document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - latvian = "Latvian", + flowChartDocument = "FlowChartDocument", /** - * Lithuanian language. + * Flow chart multidocument geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lithuanian = "Lithuanian", + flowChartMultidocument = "FlowChartMultidocument", /** - * Macedonian language. + * Flow chart terminator geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - macedonianFYROM = "MacedonianFYROM", + flowChartTerminator = "FlowChartTerminator", /** - * Malayalam language. + * Flow chart preparation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - malayalam = "Malayalam", + flowChartPreparation = "FlowChartPreparation", /** - * Malay Brunei Darussalam language. + * Flow chart manual input geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - malayBruneiDarussalam = "MalayBruneiDarussalam", + flowChartManualInput = "FlowChartManualInput", /** - * Malaysian language. + * Flow chart manual operation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - malaysian = "Malaysian", + flowChartManualOperation = "FlowChartManualOperation", /** - * Maltese language. + * Flow chart connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - maltese = "Maltese", + flowChartConnector = "FlowChartConnector", /** - * Manipuri language. + * Flow chart punched card geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - manipuri = "Manipuri", + flowChartPunchedCard = "FlowChartPunchedCard", /** - * Marathi language. + * Flow chart punched tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - marathi = "Marathi", + flowChartPunchedTape = "FlowChartPunchedTape", /** - * Mexican Spanish language. + * Flow chart summing junction geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mexicanSpanish = "MexicanSpanish", + flowChartSummingJunction = "FlowChartSummingJunction", /** - * Mongolian language. + * Flow chart OR geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mongolian = "Mongolian", + flowChartOr = "FlowChartOr", /** - * Nepali language. + * Flow chart collate geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - nepali = "Nepali", + flowChartCollate = "FlowChartCollate", /** - * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. + * Flow chart sort geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - noProofing = "NoProofing", + flowChartSort = "FlowChartSort", /** - * Norwegian Bokmol language. + * Flow chart extract geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - norwegianBokmol = "NorwegianBokmol", + flowChartExtract = "FlowChartExtract", /** - * Norwegian Nynorsk language. + * Flow chart merge geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - norwegianNynorsk = "NorwegianNynorsk", + flowChartMerge = "FlowChartMerge", /** - * Odia (Oriya) language. + * Flow chart offline storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - oriya = "Oriya", + flowChartOfflineStorage = "FlowChartOfflineStorage", /** - * Oromo language. + * Flow chart online storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - oromo = "Oromo", + flowChartOnlineStorage = "FlowChartOnlineStorage", /** - * Pashto language. + * Flow chart magnetic tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pashto = "Pashto", + flowChartMagneticTape = "FlowChartMagneticTape", /** - * Persian language. + * Flow chart magnetic disk geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - persian = "Persian", + flowChartMagneticDisk = "FlowChartMagneticDisk", /** - * Polish language. + * Flow chart magnetic drum geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - polish = "Polish", + flowChartMagneticDrum = "FlowChartMagneticDrum", /** - * Portuguese language. + * Flow chart display geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - portuguese = "Portuguese", + flowChartDisplay = "FlowChartDisplay", /** - * Portuguese (Brazil) language. + * Flow chart delay geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - portugueseBrazil = "PortugueseBrazil", + flowChartDelay = "FlowChartDelay", /** - * Punjabi language. + * Flow chart alternate process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - punjabi = "Punjabi", + flowChartAlternateProcess = "FlowChartAlternateProcess", /** - * Rhaeto Romanic language. + * Flow chart off-page connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rhaetoRomanic = "RhaetoRomanic", + flowChartOffpageConnector = "FlowChartOffpageConnector", /** - * Romanian language. + * Action button blank geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - romanian = "Romanian", + actionButtonBlank = "ActionButtonBlank", /** - * Romanian Moldova language. + * Action button home geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - romanianMoldova = "RomanianMoldova", + actionButtonHome = "ActionButtonHome", /** - * Russian language. + * Action button help geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - russian = "Russian", + actionButtonHelp = "ActionButtonHelp", /** - * Russian Moldova language. + * Action button information geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - russianMoldova = "RussianMoldova", + actionButtonInformation = "ActionButtonInformation", /** - * Sami Lappish language. + * Action button forward next geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - samiLappish = "SamiLappish", + actionButtonForwardNext = "ActionButtonForwardNext", /** - * Sanskrit language. + * Action button back previous geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sanskrit = "Sanskrit", + actionButtonBackPrevious = "ActionButtonBackPrevious", /** - * Serbian Cyrillic language. + * Action button end geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - serbianCyrillic = "SerbianCyrillic", + actionButtonEnd = "ActionButtonEnd", /** - * Serbian Latin language. + * Action button beginning geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - serbianLatin = "SerbianLatin", + actionButtonBeginning = "ActionButtonBeginning", /** - * Sesotho language. + * Action button return geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sesotho = "Sesotho", + actionButtonReturn = "ActionButtonReturn", /** - * Simplified Chinese language. + * Action button document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - simplifiedChinese = "SimplifiedChinese", + actionButtonDocument = "ActionButtonDocument", /** - * Sindhi language. + * Action button sound geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sindhi = "Sindhi", + actionButtonSound = "ActionButtonSound", /** - * Sindhi (Pakistan) language. + * Action button movie geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sindhiPakistan = "SindhiPakistan", + actionButtonMovie = "ActionButtonMovie", /** - * Sinhalese language. + * Gear 6 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sinhalese = "Sinhalese", + gear6 = "Gear6", /** - * Slovakian language. + * Gear 9 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - slovak = "Slovak", + gear9 = "Gear9", /** - * Slovenian language. + * Funnel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - slovenian = "Slovenian", + funnel = "Funnel", /** - * Somali language. + * Math plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - somali = "Somali", + mathPlus = "MathPlus", /** - * Sorbian language. + * Math minus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sorbian = "Sorbian", + mathMinus = "MathMinus", /** - * Spanish language. + * Math multiply geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanish = "Spanish", + mathMultiply = "MathMultiply", /** - * Spanish Argentina language. + * Math divide geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishArgentina = "SpanishArgentina", + mathDivide = "MathDivide", /** - * Spanish Bolivian language. + * Math equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishBolivia = "SpanishBolivia", + mathEqual = "MathEqual", /** - * Spanish Chilean language. + * Math not equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishChile = "SpanishChile", + mathNotEqual = "MathNotEqual", /** - * Spanish Colombian language. + * Corner tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishColombia = "SpanishColombia", + cornerTabs = "CornerTabs", /** - * Spanish Costa Rican language. + * Square tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishCostaRica = "SpanishCostaRica", + squareTabs = "SquareTabs", /** - * Spanish Dominican Republic language. + * Plaque tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishDominicanRepublic = "SpanishDominicanRepublic", + plaqueTabs = "PlaqueTabs", /** - * Spanish Ecuadorian language. + * Chart X geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishEcuador = "SpanishEcuador", + chartX = "ChartX", /** - * Spanish El Salvadorian language. + * Chart star geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishElSalvador = "SpanishElSalvador", + chartStar = "ChartStar", /** - * Spanish Guatemala language. + * Chart plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishGuatemala = "SpanishGuatemala", - /** - * Spanish Honduran language. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + chartPlus = "ChartPlus", + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeFillType { + /** + * No fill. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - spanishHonduras = "SpanishHonduras", + noFill = "NoFill", /** - * Spanish Modern Sort language. + * Solid fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishModernSort = "SpanishModernSort", + solid = "Solid", /** - * Spanish Nicaraguan language. + * Gradient fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishNicaragua = "SpanishNicaragua", + gradient = "Gradient", /** - * Spanish Panamanian language. + * Pattern fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishPanama = "SpanishPanama", + pattern = "Pattern", /** - * Spanish Paraguayan language. + * Picture fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishParaguay = "SpanishParaguay", + picture = "Picture", /** - * Spanish Peruvian language. + * Texture fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishPeru = "SpanishPeru", + texture = "Texture", /** - * Spanish Puerto Rican language. + * Mixed fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishPuertoRico = "SpanishPuertoRico", + mixed = "Mixed", + } + /** + * Specifies the vertical alignment for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextVerticalAlignment { /** - * Spanish Uruguayan language. + * Anchor the text at the top of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishUruguay = "SpanishUruguay", + top = "Top", /** - * Spanish Venezuelan language. + * Anchor the text at the middle of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spanishVenezuela = "SpanishVenezuela", + middle = "Middle", /** - * Sutu language. + * Anchor the text at the bottom of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sutu = "Sutu", + bottom = "Bottom", + } + /** + * Specifies the orientation for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextOrientation { /** - * Swahili language. + * No orientation, such as in a new geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - swahili = "Swahili", + none = "None", /** - * Swedish language. + * Horizontal text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - swedish = "Swedish", + horizontal = "Horizontal", /** - * Swedish Finnish language. + * 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] */ - swedishFinland = "SwedishFinland", + eastAsianVertical = "EastAsianVertical", /** - * Swiss French language. + * 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] */ - swissFrench = "SwissFrench", + vertical270 = "Vertical270", /** - * Swiss German language. + * 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] */ - swissGerman = "SwissGerman", + vertical = "Vertical", /** - * Swiss Italian language. + * 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] */ - swissItalian = "SwissItalian", + eastAsianHorizontalRotated = "EastAsianHorizontalRotated", /** - * Syriac language. + * A combination of automatic orientation is used. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + mixed = "Mixed", + } + /** + * Determines the type of automatic sizing allowed. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeAutoSize { + /** + * No autosizing. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + none = "None", + /** + * The text is adjusted to fit the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + textToFitShape = "TextToFitShape", + /** + * The shape is adjusted to fit the text. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shapeToFitText = "ShapeToFitText", + /** + * A combination of automatic sizing schemes are used. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + 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 { + /** + * Places the shape in line with text. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + inline = "Inline", + /** + * Wraps text squarely around the shape. + * @remarks + * [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", + /** + * Both left and right sides of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + both = "Both", + /** + * Left side of the shape only. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + left = "Left", + /** + * Right side of the shape only. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + right = "Right", + /** + * Side of the shape that's farther from the respective page margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + largest = "Largest", + } + /** + * Specifies the scale size type of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleType { + /** + * Scale from current size of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + currentSize = "CurrentSize", + /** + * Scale from original size of the shape. It only works for pictures. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + originalSize = "OriginalSize", + } + /** + * Specifies which part of the shape retains its position when the shape is scaled. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleFrom { + /** + * Scale from the top left corner of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + scaleFromTopLeft = "ScaleFromTopLeft", + /** + * 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 */ - syriac = "Syriac", + auto = "Auto", /** - * Tajik language. + * 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 */ - tajik = "Tajik", + atLeast = "AtLeast", /** - * Tamazight language. + * 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 */ - tamazight = "Tamazight", + exact = "Exact", + } + /** + * Specifies the border style for an object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BorderLineStyle { /** - * Tamazight Latin language. + * No line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tamazightLatin = "TamazightLatin", + none = "None", /** - * Tamil language. + * Single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tamil = "Tamil", + single = "Single", /** - * Tatar language. + * Dotted line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tatar = "Tatar", + dot = "Dot", /** - * Telugu language. + * Dashed line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - telugu = "Telugu", + dashSmallGap = "DashSmallGap", /** - * Thai language. + * Dashed line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thai = "Thai", + dashLargeGap = "DashLargeGap", /** - * Tibetan language. + * Dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tibetan = "Tibetan", + dashDot = "DashDot", /** - * Tigrigna Eritrea language. + * Dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tigrignaEritrea = "TigrignaEritrea", + dashDotDot = "DashDotDot", /** - * Tigrigna Ethiopic language. + * Double line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tigrignaEthiopic = "TigrignaEthiopic", + double = "Double", /** - * Traditional Chinese language. + * Triple line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChinese = "TraditionalChinese", + triple = "Triple", /** - * Tsonga language. + * Thin-thick line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tsonga = "Tsonga", + thinThickSmallGap = "ThinThickSmallGap", /** - * Tswana language. + * Thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tswana = "Tswana", + thickThinSmallGap = "ThickThinSmallGap", /** - * Turkish language. + * Thin-thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turkish = "Turkish", + thinThickThinSmallGap = "ThinThickThinSmallGap", /** - * Turkmen language. + * Thin-thick line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turkmen = "Turkmen", + thinThickMedGap = "ThinThickMedGap", /** - * Ukrainian language. + * Thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ukrainian = "Ukrainian", + thickThinMedGap = "ThickThinMedGap", /** - * Urdu language. + * Thin-thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - urdu = "Urdu", + thinThickThinMedGap = "ThinThickThinMedGap", /** - * Uzbek Cyrillic language. + * Thin-thick line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uzbekCyrillic = "UzbekCyrillic", + thinThickLargeGap = "ThinThickLargeGap", /** - * Uzbek Latin language. + * Thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uzbekLatin = "UzbekLatin", + thickThinLargeGap = "ThickThinLargeGap", /** - * Venda language. + * Thin-thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - venda = "Venda", + thinThickThinLargeGap = "ThinThickThinLargeGap", /** - * Vietnamese language. + * Single wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vietnamese = "Vietnamese", + singleWavy = "SingleWavy", /** - * Welsh language. + * Double wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - welsh = "Welsh", + doubleWavy = "DoubleWavy", /** - * Xhosa language. + * Dash-dot stroked line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xhosa = "Xhosa", + dashDotStroked = "DashDotStroked", /** - * Yi language. + * Embossed 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yi = "Yi", + emboss3D = "Emboss3D", /** - * Yiddish language. + * Engraved 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yiddish = "Yiddish", + engrave3D = "Engrave3D", /** - * Yoruba language. + * Outset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yoruba = "Yoruba", + outset = "Outset", /** - * Zulu language. + * Inset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zulu = "Zulu", + inset = "Inset", } /** - * Represents the type of a {@link Word.CustomXmlValidationError}. + * Specifies the width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CustomXmlValidationErrorType { + enum LineWidth { /** - * Represents a validation error generated by the schema. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - schemaGenerated = "schemaGenerated", - /** - * Represents a validation error that is automatically cleared. + * Represents a line width of 0.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyCleared = "automaticallyCleared", + pt025 = "Pt025", /** - * Represents a validation error that is manually created. + * Represents a line width of 0.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - manual = "manual", - } - /** - * Represents the type of a {@link Word.CustomXmlNode}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CustomXmlNodeType { + pt050 = "Pt050", /** - * Represents an XML element node. + * Represents a line width of 0.75 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - element = "element", + pt075 = "Pt075", /** - * Represents an XML attribute node. + * Represents a line width of 1.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attribute = "attribute", + pt100 = "Pt100", /** - * Represents an XML text node. + * Represents a line width of 1.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text = "text", + pt150 = "Pt150", /** - * Represents an XML CDATA section node. + * Represents a line width of 2.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cData = "cData", + pt225 = "Pt225", /** - * Represents an XML processing instruction node. + * Represents a line width of 3.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - processingInstruction = "processingInstruction", + pt300 = "Pt300", /** - * Represents an XML comment node. + * Represents a line width of 4.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comment = "comment", + pt450 = "Pt450", /** - * Represents an XML document node. + * Represents a line width of 6.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - document = "document", + pt600 = "Pt600", } /** - * Represents the list formatting characteristics of a range. + * Specifies the graphical page border setting of a page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 PageBorderArt { /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * + * Represents a border with apple design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly list: Word.List; + apples = "Apples", /** - * Gets the list template associated with the `ListFormat` object. - * + * Represents a border with maple muffin design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listTemplate: Word.ListTemplate; + mapleMuffins = "MapleMuffins", /** - * Indicates whether the `ListFormat` object contains a single list. - * + * Represents a border with cake slice design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isSingleList: boolean; + cakeSlice = "CakeSlice", /** - * Indicates whether the `ListFormat` object contains a single list template. - * + * Represents a border with candy corn design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isSingleListTemplate: boolean; + candyCorn = "CandyCorn", /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. - * + * Represents a border with ice cream cone design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber: number; + iceCreamCones = "IceCreamCones", /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. - * + * Represents a border with champagne bottle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listString: string; + champagneBottle = "ChampagneBottle", /** - * Gets the type of the list for the `ListFormat` object. - * + * Represents a border with party glass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + partyGlass = "PartyGlass", /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. - * + * Represents a border with Christmas tree design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listValue: number; + christmasTree = "ChristmasTree", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents a border with trees design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + trees = "Trees", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Represents a border with palm trees in color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; + palmsColor = "PalmsColor", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Represents a border with three-color balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + balloons3Colors = "Balloons3Colors", /** - * Applies a list template with a specific level to the paragraphs in the range. - * + * Represents a border with hot air balloons design. * @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. */ - applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; + balloonsHotAir = "BalloonsHotAir", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Represents a border with party favor design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. */ - applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + partyFavor = "PartyFavor", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Represents a border with confetti streamers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. */ - applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + confettiStreamers = "ConfettiStreamers", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Represents a border with hearts design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. */ - applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + hearts = "Hearts", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Represents a border with heart balloon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. */ - applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + heartBalloon = "HeartBalloon", /** - * Determines whether the `ListFormat` object can continue a previous list. - * + * Represents a border with 3D stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param listTemplate The list template to check. - * @returns A `Continue` value indicating whether continuation is possible. */ - canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; + stars3D = "Stars3D", /** - * Converts numbers in the list to plain text. - * + * Represents a border with shadowed stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType Optional. The type of number to convert. */ - convertNumbersToText(numberType: Word.NumberType): void; + starsShadowed = "StarsShadowed", /** - * Converts numbers in the list to plain text. - * + * Represents a border with stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType Optional. The type of number to convert. */ - convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + stars = "Stars", /** - * Counts the numbered items in the list. - * + * Represents a border with sun design. * @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. */ - countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; + sun = "Sun", /** - * Indents the list by one level. - * + * Represents a border with Earth design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listIndent(): void; + earth2 = "Earth2", /** - * Outdents the list by one level. - * + * Represents a border with Earth design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listOutdent(): void; + earth1 = "Earth1", /** - * Removes numbering from the list. - * + * Represents a border with people wearing hats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType Optional. The type of number to remove. */ - removeNumbers(numberType: Word.NumberType): void; + peopleHats = "PeopleHats", /** - * Removes numbering from the list. - * + * Represents a border with sombrero design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType Optional. The type of number to remove. */ - removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + sombrero = "Sombrero", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with pencils design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; + pencils = "Pencils", /** - * Queues up a command to load the specified properties of the object. You must 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 a border with packages design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ListFormat; + packages = "Packages", /** - * 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 a border with clocks design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ListFormat; + clocks = "Clocks", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the 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 a border with firecrackers design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ListFormat; + firecrackers = "Firecrackers", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to 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 a border with rings design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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.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.ListFormatData; - } - /** - * Represents options for counting numbered items in a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ListFormatCountNumberedItemsOptions { + rings = "Rings", /** - * If provided, specifies the level to count. The default value is 1. - * + * Represents a border with map pins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: number; + mapPins = "MapPins", /** - * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. - * + * Represents a border with confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + confetti = "Confetti", /** - * If provided, specifies the level to apply in the list template. The default value is 1. - * + * Represents a border with butterfly creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLevel?: number; + creaturesButterfly = "CreaturesButterfly", /** - * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. - * + * Represents a border with ladybug creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; + creaturesLadyBug = "CreaturesLadyBug", /** - * If provided, specifies whether to continue the previous list. The default value is `false`. - * + * Represents a border with fish creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - continuePreviousList?: boolean; + creaturesFish = "CreaturesFish", /** - * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. - * + * Represents a border with birds in flight design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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; + birdsFlight = "BirdsFlight", /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * + * Represents a border with scared cat design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly backgroundColor: Word.ColorFormat; + scaredCat = "ScaredCat", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * + * Represents a border with bats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + bats = "Bats", /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. - * + * Represents a border with roses flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle: number; + flowersRoses = "FlowersRoses", /** - * Gets the gradient color type. - * + * Represents a border with red rose flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + flowersRedRose = "FlowersRedRose", /** - * 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. - * + * Represents a border with poinsettias flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientDegree: number; + poinsettias = "Poinsettias", /** - * Returns the gradient style for the fill. - * + * Represents a border with holly design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + holly = "Holly", /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. - * + * Represents a border with tiny flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientVariant: number; + flowersTiny = "FlowersTiny", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Represents a border with pansy flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + flowersPansy = "FlowersPansy", /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. - * + * Represents a border with modern 2 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + flowersModern2 = "FlowersModern2", /** - * Returns the preset gradient type for the fill. - * + * Represents a border with modern 1 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + flowersModern1 = "FlowersModern1", /** - * Gets the preset texture. - * + * Represents a border with white flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + whiteFlowers = "WhiteFlowers", /** - * Specifies whether the fill rotates with the shape. - * + * Represents a border with vine design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject: boolean; + vine = "Vine", /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * + * Represents a border with daisies flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + flowersDaisies = "FlowersDaisies", /** - * Specifies the horizontal scaling factor for the texture fill. - * + * Represents a border with block print flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale: number; + flowersBlockPrint = "FlowersBlockPrint", /** - * Returns the name of the custom texture file for the fill. - * + * Represents a border with colored deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textureName: string; + decoArchColor = "DecoArchColor", /** - * Specifies the horizontal offset of the texture from the origin in points. - * + * Represents a border with fans design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX: number; + fans = "Fans", /** - * Specifies the vertical offset of the texture. - * + * Represents a border with film design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY: number; + film = "Film", /** - * Specifies whether the texture is tiled. - * + * Represents a border with lightning design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile: boolean; + lightning1 = "Lightning1", /** - * Returns the texture type for the fill. - * + * Represents a border with compass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + compass = "Compass", /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. - * + * Represents a border with double D design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale: number; + doubleD = "DoubleD", /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). - * + * Represents a border with classical wave design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + classicalWave = "ClassicalWave", /** - * Gets the fill format type. - * + * Represents a border with shadowed squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + shadowedSquares = "ShadowedSquares", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents a border with twisted lines design (variant 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + twistedLines1 = "TwistedLines1", /** - * Sets the fill to a one-color gradient. - * + * Represents a border with waveline design. * @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). */ - setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; + waveline = "Waveline", /** - * Sets the fill to a one-color gradient. - * + * Represents a border with quadrants design. * @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). */ - setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; + quadrants = "Quadrants", /** - * Sets the fill to a pattern. - * + * Represents a border with colored checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPatterned(pattern: Word.PatternType): void; + checkedBarColor = "CheckedBarColor", /** - * Sets the fill to a pattern. - * + * Represents a border with swirligig design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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; + swirligig = "Swirligig", /** - * 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. - * + * Represents a border with push pin note design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; + pushPinNote1 = "PushPinNote1", /** - * 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. - * + * Represents a border with push pin note design (variant 2). * @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; + pushPinNote2 = "PushPinNote2", /** - * Sets the fill to a preset texture. - * + * Represents a border with pumpkin design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetTextured(presetTexture: Word.PresetTexture): void; + pumpkin1 = "Pumpkin1", /** - * Sets the fill to a preset texture. - * + * Represents a border with black eggs design. * @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; + eggsBlack = "EggsBlack", /** - * Sets the fill to a two-color gradient. - * + * Represents a border with cup design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setTwoColorGradient(style: Word.GradientStyle, variant: number): void; + cup = "Cup", /** - * Sets the fill to a two-color gradient. - * + * Represents a border with gray heart design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; + heartGray = "HeartGray", /** - * Sets the fill to a uniform color. - * + * Represents a border with gingerbread man design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid(): void; + gingerbreadMan = "GingerbreadMan", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with baby pacifier design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; + babyPacifier = "BabyPacifier", /** - * Queues up a command to load the specified properties of the object. You must 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 a border with baby rattle design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.FillFormat; + babyRattle = "BabyRattle", /** - * 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 a border with cabins design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.FillFormat; + cabins = "Cabins", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the 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 a border with funky house design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.FillFormat; + houseFunky = "HouseFunky", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to 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 a border with black stars design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + starsBlack = "StarsBlack", /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * + * Represents a border with snowflakes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly color: Word.ColorFormat; + snowflakes = "Snowflakes", /** - * Specifies the length of the radius for a glow effect. - * + * Represents a border with fancy snowflake design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius: number; + snowflakeFancy = "SnowflakeFancy", /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Represents a border with skyrocket design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + skyrocket = "Skyrocket", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents a border with Seattle design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + seattle = "Seattle", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with music notes design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; + musicNotes = "MusicNotes", /** - * Queues up a command to load the specified properties of the object. You must 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 a border with black palms design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.GlowFormat; + palmsBlack = "PalmsBlack", /** - * 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 a border with maple leaf design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.GlowFormat; + mapleLeaf = "MapleLeaf", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the 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 a border with paper clips design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.GlowFormat; + paperClips = "PaperClips", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to 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 a border with shorebird tracks design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.GlowFormat; + shorebirdTracks = "ShorebirdTracks", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. - */ - 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; + * Represents a border with people design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + people = "People", /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * + * Represents a border with people waving design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly backgroundColor: Word.ColorFormat; + peopleWaving = "PeopleWaving", /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * + * Represents a border with eclipsing squares design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + eclipsingSquares2 = "EclipsingSquares2", /** - * Specifies the length of the arrowhead at the beginning of the line. - * + * Represents a border with hypnotic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + hypnotic = "Hypnotic", /** - * Specifies the style of the arrowhead at the beginning of the line. - * + * Represents a border with gray diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + diamondsGray = "DiamondsGray", /** - * Specifies the width of the arrowhead at the beginning of the line. - * + * Represents a border with deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + decoArch = "DecoArch", /** - * Specifies the dash style for the line. - * + * Represents a border with deco blocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + decoBlocks = "DecoBlocks", /** - * Specifies the length of the arrowhead at the end of the line. - * + * Represents a border with circles and lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + circlesLines = "CirclesLines", /** - * Specifies the style of the arrowhead at the end of the line. - * + * Represents a border with papyrus design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + papyrus = "Papyrus", /** - * Specifies the width of the arrowhead at the end of the line. - * + * Represents a border with woodwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + woodwork = "Woodwork", /** - * Specifies if to draw lines inside a shape. - * + * Represents a border with weaving braid design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen: boolean; + weavingBraid = "WeavingBraid", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Represents a border with weaving ribbon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + weavingRibbon = "WeavingRibbon", /** - * Specifies the pattern applied to the line. - * + * Represents a border with weaving angles design. * @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"; + weavingAngles = "WeavingAngles", /** - * Specifies the line format style. - * + * Represents a border with arched scallops design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + archedScallops = "ArchedScallops", /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). - * + * Represents a border with safari design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + safari = "Safari", /** - * Specifies the thickness of the line in points. - * + * Represents a border with Celtic knotwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight: number; + celticKnotwork = "CelticKnotwork", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents a border with crazy maze design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + crazyMaze = "CrazyMaze", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with eclipsing squares design (variant 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; + eclipsingSquares1 = "EclipsingSquares1", /** - * Queues up a command to load the specified properties of the object. You must 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 a border with birds design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.LineFormat; + birds = "Birds", /** - * 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 a border with teacup and flowers design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.LineFormat; + flowersTeacup = "FlowersTeacup", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the 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 a border with northwest design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.LineFormat; + northwest = "Northwest", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to 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 a border with southwest design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.LineFormat; + southwest = "Southwest", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. - */ - 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; + * Represents a border with tribal design (variant 6). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tribal6 = "Tribal6", /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. - * + * Represents a border with tribal design (variant 4). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur: number; + tribal4 = "Tribal4", /** - * Specifies the amount of separation, in points, of the reflected image from the shape. - * + * Represents a border with tribal design (variant 3). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset: number; + tribal3 = "Tribal3", /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. - * + * Represents a border with tribal design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size: number; + tribal2 = "Tribal2", /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Represents a border with tribal design (variant 5). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + tribal5 = "Tribal5", /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. - * + * Represents a border with X illusions design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + xillusions = "XIllusions", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents a border with zany triangles design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + zanyTriangles = "ZanyTriangles", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with pyramids design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; + pyramids = "Pyramids", /** - * Queues up a command to load the specified properties of the object. You must 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 a border with pyramids above design. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ReflectionFormat; + pyramidsAbove = "PyramidsAbove", /** - * 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.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.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.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.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.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; - /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Represents a border with gray confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness: number; + confettiGrays = "ConfettiGrays", /** - * Specifies the theme color for a color format. - * + * Represents a border with outline confetti design. * @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"; + confettiOutline = "ConfettiOutline", /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. - * + * Represents a border with white confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb: string; + confettiWhite = "ConfettiWhite", /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Represents a border with mosaic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade: number; + mosaic = "Mosaic", /** - * Returns the shape color type. - * + * Represents a border with lightning design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.ColorType | "rgb" | "scheme"; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on 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.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; - /** - * Queues up a command to load the specified properties 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.ColorFormatLoadOptions): Word.ColorFormat; - /** - * Queues up a command to load the specified properties of the object. You must 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.ColorFormat; - /** - * 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.ColorFormat; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - 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; - } - /** - * 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; + lightning2 = "Lightning2", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * + * Represents a border with heebie jeebies design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + heebieJeebies = "HeebieJeebies", /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. - * + * Represents a border with light bulb design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur: number; + lightBulb = "LightBulb", /** - * Specifies whether the object or the formatting applied to it is visible. - * + * Represents a border with gradient design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + gradient = "Gradient", /** - * 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. - * + * Represents a border with triangle party design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured: boolean; + triangleParty = "TriangleParty", /** - * 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. - * + * Represents a border with twisted lines design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX: number; + twistedLines2 = "TwistedLines2", /** - * 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. - * + * Represents a border with moons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY: number; + moons = "Moons", /** - * Specifies whether to rotate the shadow when rotating the shape. - * + * Represents a border with ovals design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape: boolean; + ovals = "Ovals", /** - * Specifies the width of the shadow. - * + * Represents a border with double diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size: number; + doubleDiamonds = "DoubleDiamonds", /** - * Specifies the type of shadow formatting to apply to a shape. - * + * Represents a border with chain link design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + chainLink = "ChainLink", /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). - * + * Represents a border with triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + triangles = "Triangles", /** - * Specifies the shape shadow type. - * + * Represents a border with tribal design (variant 1). * @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. - */ - 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; + tribal1 = "Tribal1", /** - * Changes the horizontal offset of the shadow by the number of points. - Increment The number of points to adjust. - * + * Represents a border with marquee toothed design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementOffsetX(increment: number): void; + marqueeToothed = "MarqueeToothed", /** - * Changes the vertical offset of the shadow by the specified number of points. - Increment The number of points to adjust. - * + * Represents a border with sharks teeth design. * @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. - */ - 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 - */ - 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; + sharksTeeth = "SharksTeeth", /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * + * Represents a border with sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly contourColor: Word.ColorFormat; + sawtooth = "Sawtooth", /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * + * Represents a border with gray sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly extrusionColor: Word.ColorFormat; + sawtoothGray = "SawtoothGray", /** - * Specifies the depth of the bottom bevel. - * + * Represents a border with postage stamp design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth: number; + postageStamp = "PostageStamp", /** - * Specifies the inset size for the bottom bevel. - * + * Represents a border with weaving strips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset: number; + weavingStrips = "WeavingStrips", /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. - * + * Represents a border with zigzag design. * @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"; + zigZag = "ZigZag", /** - * Specifies the depth of the top bevel. - * + * Represents a border with cross stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth: number; + crossStitch = "CrossStitch", /** - * Specifies the inset size for the top bevel. - * + * Represents a border with gems design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset: number; + gems = "Gems", /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. - * + * Represents a border with circles and rectangles design. * @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"; + circlesRectangles = "CirclesRectangles", /** - * Specifies the width of the contour of a shape. - * + * Represents a border with corner triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth: number; + cornerTriangles = "CornerTriangles", /** - * Specifies the depth of the shape's extrusion. - * + * Represents a border with insects creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth: number; + creaturesInsects = "CreaturesInsects", /** - * 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. - * + * Represents a border with zigzag stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + zigZagStitch = "ZigZagStitch", /** - * Specifies the amount of perspective for a shape. - * + * Represents a border with checkered design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView: number; + checkered = "Checkered", /** - * 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. - * + * Represents a border with black checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective: boolean; + checkedBarBlack = "CheckedBarBlack", /** - * Specifies if the specified object, or the formatting applied to it, is visible. - * + * Represents a border with marquee design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + marquee = "Marquee", /** - * Specifies the angle of the lighting. - * + * Represents a border with basic white dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle: number; + basicWhiteDots = "BasicWhiteDots", /** - * Returns a `PresetCamera` value that represents the camera presets. - * + * Represents a border with basic wide midline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + basicWideMidline = "BasicWideMidline", /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). - * + * Represents a border with basic wide outline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + basicWideOutline = "BasicWideOutline", /** - * Specifies a `LightRigType` value that represents the lighting preset. - * + * Represents a border with basic wide inline design. * @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"; + basicWideInline = "BasicWideInline", /** - * Specifies the position of the light source relative to the extrusion. - * + * Represents a border with basic thin lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + basicThinLines = "BasicThinLines", /** - * Specifies the intensity of the extrusion lighting. - * + * Represents a border with basic white dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + basicWhiteDashes = "BasicWhiteDashes", /** - * Specifies the extrusion surface material. - * + * Represents a border with basic white squares design. * @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"; + basicWhiteSquares = "BasicWhiteSquares", /** - * Returns the preset extrusion format. - * + * Represents a border with basic black squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + basicBlackSquares = "BasicBlackSquares", /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. - * + * Represents a border with basic black dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText: boolean; + basicBlackDashes = "BasicBlackDashes", /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. - * + * Represents a border with basic black dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX: number; + basicBlackDots = "BasicBlackDots", /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. - * + * Represents a border with top stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY: number; + starsTop = "StarsTop", /** - * Specifies the z-axis rotation of the camera. - * + * Represents a border with certificate banner design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ: number; + certificateBanner = "CertificateBanner", /** - * Specifies the position on the z-axis for the shape. - * + * Represents a border with handmade design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z: 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.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; + handmade1 = "Handmade1", /** - * Horizontally rotates a shape on the x-axis. - The number of degrees to rotate. - * + * Represents a border with handmade design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationHorizontal(increment: number): void; + handmade2 = "Handmade2", /** - * Vertically rotates a shape on the y-axis. - The number of degrees to rotate. - * + * Represents a border with torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationVertical(increment: number): void; + tornPaper = "TornPaper", /** - * Changes the rotation around the x-axis. - The number of degrees to rotate. - * + * Represents a border with black torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationX(increment: number): void; + tornPaperBlack = "TornPaperBlack", /** - * Changes the rotation around the y-axis. - The number of degrees to rotate. - * + * Represents a border with coupon cutout dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationY(increment: number): void; + couponCutoutDashes = "CouponCutoutDashes", /** - * Rotates a shape on the z-axis. - The number of degrees to rotate. - * + * Represents a border with coupon cutout dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationZ(increment: number): void; + 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 { /** - * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. - * + * Automatically select the unit of measure to use based on the current selection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resetRotation(): void; + auto = "Auto", /** - * Sets the direction of the extrusion's sweep path. - * + * Measure the current item width using a specified percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param presetExtrusionDirection The preset direction. */ - setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; + percent = "Percent", /** - * Sets the direction of the extrusion's sweep path. - * + * Measure the current item width using a specified number of points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param presetExtrusionDirection The preset direction. */ - setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; + points = "Points", + } + /** + * Specifies the way Word adjusts the table when the left indent is changed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RulerStyle { /** - * Sets the camera preset for the shape. - The preset 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 */ - setPresetCamera(presetCamera: Word.PresetCamera): void; + none = "None", /** - * Sets the camera preset for the shape. - The preset 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 */ - 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; + proportional = "Proportional", /** - * Sets the preset extrusion format. - The preset format. - * + * 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 */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + firstColumn = "FirstColumn", /** - * Sets the preset extrusion format. - The preset format. - * + * 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 */ - 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; + sameWidth = "SameWidth", } /** - * Specifies the length of the arrowhead at the end of a line. + * 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 ArrowheadLength { + enum FarEastLineBreakLanguageId { /** - * Represents a mixed arrowhead length. + * Represents Traditional Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + traditionalChinese = "TraditionalChinese", /** - * Represents a short arrowhead length. + * Represents Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - short = "Short", + japanese = "Japanese", /** - * Represents a medium arrowhead length. + * Represents Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - medium = "Medium", + korean = "Korean", /** - * Represents a long arrowhead length. + * Represents Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - long = "Long", + simplifiedChinese = "SimplifiedChinese", } /** - * Specifies the style of the arrowhead at the end of a line. + * 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 ArrowheadStyle { + enum FarEastLineBreakLevel { /** - * Represents a mixed arrowhead style. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - mixed = "Mixed", - /** - * Represents no arrowhead. + * Represents the normal line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + normal = "Normal", /** - * Represents a triangle arrowhead style. + * Represents the strict line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - triangle = "Triangle", + strict = "Strict", /** - * Represents an open arrowhead style. + * Represents the custom line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - open = "Open", + custom = "Custom", + } + /** + * Specifies the character spacing adjustment for a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum JustificationMode { /** - * Represents a stealth arrowhead style. + * Expands the character spacing * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stealth = "Stealth", + expand = "Expand", /** - * Represents a diamond arrowhead style. + * Compresses the character spacing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diamond = "Diamond", + compress = "Compress", /** - * Represents an oval arrowhead style. + * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oval = "Oval", + compressKana = "CompressKana", } /** - * Specifies the width of the arrowhead at the end of a line. + * Specifies the type of template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ArrowheadWidth { - /** - * Represents a mixed arrowhead width. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - mixed = "Mixed", + enum TemplateType { /** - * Represents a narrow arrowhead width. + * Represents the normal template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrow = "Narrow", + normal = "Normal", /** - * Represents a medium arrowhead width. + * Represents the global template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - medium = "Medium", + global = "Global", /** - * Represents a wide arrowhead width. + * Represents the attached template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wide = "Wide", + attached = "Attached", } /** - * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * Represents the language ID of a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BevelType { + enum LanguageId { /** - * Represents a mixed bevel type. + * Afrikaans language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "mixed", + afrikaans = "Afrikaans", /** - * Represents no bevel. + * Albanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "none", + albanian = "Albanian", /** - * Represents a relaxed inset bevel. + * Amharic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relaxedInset = "relaxedInset", + amharic = "Amharic", /** - * Represents a circle bevel. + * Arabic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circle = "circle", + arabic = "Arabic", /** - * Represents a slope bevel. + * Arabic Algerian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - slope = "slope", + arabicAlgeria = "ArabicAlgeria", /** - * Represents a cross bevel. + * Arabic Bahraini language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "cross", + arabicBahrain = "ArabicBahrain", /** - * Represents an angle bevel. + * Arabic Egyptian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - angle = "angle", + arabicEgypt = "ArabicEgypt", /** - * Represents a soft round bevel. + * Arabic Iraqi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softRound = "softRound", + arabicIraq = "ArabicIraq", /** - * Represents a convex bevel. + * Arabic Jordanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - convex = "convex", + arabicJordan = "ArabicJordan", /** - * Represents a cool slant bevel. + * Arabic Kuwaiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coolSlant = "coolSlant", + arabicKuwait = "ArabicKuwait", /** - * Represents a divot bevel. + * Arabic Lebanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "divot", + arabicLebanon = "ArabicLebanon", /** - * Represents a riblet bevel. + * Arabic Libyan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - riblet = "riblet", + arabicLibya = "ArabicLibya", /** - * Represents a hard edge bevel. + * Arabic Moroccan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hardEdge = "hardEdge", + arabicMorocco = "ArabicMorocco", /** - * Represents an art deco bevel. + * Arabic Omani language. * @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 { + arabicOman = "ArabicOman", /** - * Automatically determines the color. + * Arabic Qatari language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + arabicQatar = "ArabicQatar", /** - * Represents the color black. + * Arabic Syrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - black = "Black", + arabicSyria = "ArabicSyria", /** - * Represents the color blue. + * Arabic Tunisian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blue = "Blue", + arabicTunisia = "ArabicTunisia", /** - * Represents the color turquoise. + * Arabic United Arab Emirates language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turquoise = "Turquoise", + arabicUAE = "ArabicUAE", /** - * Represents a bright green color. + * Arabic Yemeni language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightGreen = "BrightGreen", + arabicYemen = "ArabicYemen", /** - * Represents the color pink. + * Armenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pink = "Pink", + armenian = "Armenian", /** - * Represents the color red. + * Assamese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - red = "Red", + assamese = "Assamese", /** - * Represents the color yellow. + * Azerbaijani Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yellow = "Yellow", + azeriCyrillic = "AzeriCyrillic", /** - * Represents the color white. + * Azerbaijani Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - white = "White", + azeriLatin = "AzeriLatin", /** - * Represents a dark blue color. + * Basque (Basque). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkBlue = "DarkBlue", + basque = "Basque", /** - * Represents the color teal. + * Belgian Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - teal = "Teal", + belgianDutch = "BelgianDutch", /** - * Represents the color green. + * Belgian French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - green = "Green", + belgianFrench = "BelgianFrench", /** - * Represents the color violet. + * Bengali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - violet = "Violet", + bengali = "Bengali", /** - * Represents a dark red color. + * Bulgarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkRed = "DarkRed", + bulgarian = "Bulgarian", /** - * Represents a dark yellow color. + * Burmese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkYellow = "DarkYellow", + burmese = "Burmese", /** - * Represents a gray color with 50% intensity. + * Belarusian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gray50 = "Gray50", + belarusian = "Belarusian", /** - * Represents a gray color with 25% intensity. + * Catalan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gray25 = "Gray25", + catalan = "Catalan", /** - * Represents a classic red color. + * Cherokee language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicRed = "ClassicRed", + cherokee = "Cherokee", /** - * Represents a classic blue color. + * Chinese Hong Kong SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicBlue = "ClassicBlue", + chineseHongKongSAR = "ChineseHongKongSAR", /** - * Represents a color determined by the author. + * Chinese Macao SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - byAuthor = "ByAuthor", - } - /** - * Specifies the color type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColorType { + chineseMacaoSAR = "ChineseMacaoSAR", /** - * Represents an RGB color type. + * Chinese Singapore language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb = "rgb", + chineseSingapore = "ChineseSingapore", /** - * Represents a scheme color type. + * Croatian language. * @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 { + croatian = "Croatian", /** - * Formatting cannot continue from the previous list. + * Czech language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disabled = "Disabled", + czech = "Czech", /** - * Formatting can continue from the previous list. + * Danish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + danish = "Danish", /** - * Numbering can be restarted. + * Divehi language. * @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 { + divehi = "Divehi", /** - * Use formatting compatible with Microsoft Word 97. + * Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word97 = "Word97", + dutch = "Dutch", /** - * Use Web-oriented formatting as introduced in Microsoft Word 2000. + * Edo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word2000 = "Word2000", + edo = "Edo", /** - * Use formatting compatible with Microsoft Word 2002. + * Australian English language. * @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 { + englishAUS = "EnglishAUS", /** - * No emphasis mark. + * Belize English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + englishBelize = "EnglishBelize", /** - * Emphasis mark over a solid circle. + * Canadian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overSolidCircle = "OverSolidCircle", + englishCanadian = "EnglishCanadian", /** - * Emphasis mark over a comma. + * Caribbean English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overComma = "OverComma", + englishCaribbean = "EnglishCaribbean", /** - * Emphasis mark over a white circle. + * Indonesian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overWhiteCircle = "OverWhiteCircle", + englishIndonesia = "EnglishIndonesia", /** - * Emphasis mark under a solid circle. + * Irish English language. * @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 { + englishIreland = "EnglishIreland", /** - * Represents a mixed extrusion color type. + * Jamaican English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "mixed", + englishJamaica = "EnglishJamaica", /** - * Represents an automatic extrusion color based on the shape's fill. + * New Zealand English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automatic = "automatic", + englishNewZealand = "EnglishNewZealand", /** - * Represents a custom extrusion color independent of the shape's fill. + * Filipino English language. * @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 { + englishPhilippines = "EnglishPhilippines", /** - * Represents a mixed fill type. + * South African English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + englishSouthAfrica = "EnglishSouthAfrica", /** - * Represents a solid fill type. + * Tobago Trinidad English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + englishTrinidadTobago = "EnglishTrinidadTobago", /** - * Represents a patterned fill type. + * United Kingdom English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - patterned = "Patterned", + englishUK = "EnglishUK", /** - * Represents a gradient fill type. + * United States English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradient = "Gradient", + englishUS = "EnglishUS", /** - * Represents a textured fill type. + * Zimbabwe English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textured = "Textured", + englishZimbabwe = "EnglishZimbabwe", /** - * Represents a background fill type. + * Estonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background = "Background", + estonian = "Estonian", /** - * Represents a picture fill type. + * Faeroese language. * @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 { + faeroese = "Faeroese", /** - * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. + * Filipino language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + filipino = "Filipino", /** - * Gradient with a single color and varying transparency or brightness. + * Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oneColor = "OneColor", + finnish = "Finnish", /** - * Gradient that blends two distinct colors. + * French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoColors = "TwoColors", + french = "French", /** - * Gradient that uses a predefined set of colors. + * French Cameroon language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetColors = "PresetColors", + frenchCameroon = "FrenchCameroon", /** - * Gradient that includes more than two colors, often customized. + * French Canadian language. * @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 { + frenchCanadian = "FrenchCanadian", /** - * Represents a mixed gradient style. + * French (Congo (DRC)) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + frenchCongoDRC = "FrenchCongoDRC", /** - * Represents a horizontal gradient style. + * French Cote d'Ivoire language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + frenchCotedIvoire = "FrenchCotedIvoire", /** - * Represents a vertical gradient style. + * French Haiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + frenchHaiti = "FrenchHaiti", /** - * Represents a diagonal-up gradient style. + * French Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalUp = "DiagonalUp", + frenchLuxembourg = "FrenchLuxembourg", /** - * Represents a diagonal-down gradient style. + * French Mali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalDown = "DiagonalDown", + frenchMali = "FrenchMali", /** - * Represents a gradient style from the corner. + * French Monaco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fromCorner = "FromCorner", + frenchMonaco = "FrenchMonaco", /** - * Represents a gradient style from the title. + * French Morocco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fromTitle = "FromTitle", + frenchMorocco = "FrenchMorocco", /** - * Represents a gradient style from the center. + * French Reunion language. * @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 { + frenchReunion = "FrenchReunion", /** - * No ligatures applied. + * French Senegal language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + frenchSenegal = "FrenchSenegal", /** - * Standard ligatures applied. + * French West Indies language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standard = "Standard", + frenchWestIndies = "FrenchWestIndies", /** - * Contextual ligatures applied. + * Frisian Netherlands language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextual = "Contextual", + frisianNetherlands = "FrisianNetherlands", /** - * Standard and contextual ligatures applied. + * Fulfulde language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextual = "StandardContextual", + fulfulde = "Fulfulde", /** - * Historical ligatures applied. + * Irish (Irish) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historical = "Historical", + gaelicIreland = "GaelicIreland", /** - * Standard and historical ligatures applied. + * Scottish Gaelic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardHistorical = "StandardHistorical", + gaelicScotland = "GaelicScotland", /** - * Contextual and historical ligatures applied. + * Galician language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualHistorical = "ContextualHistorical", + galician = "Galician", /** - * Standard, contextual, and historical ligatures applied. + * Georgian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextualHistorical = "StandardContextualHistorical", + georgian = "Georgian", /** - * Discretional ligatures applied. + * German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - discretional = "Discretional", + german = "German", /** - * Standard and discretional ligatures applied. + * German Austrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardDiscretional = "StandardDiscretional", + germanAustria = "GermanAustria", /** - * Contextual and discretional ligatures applied. + * German Liechtenstein language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualDiscretional = "ContextualDiscretional", + germanLiechtenstein = "GermanLiechtenstein", /** - * Standard, contextual, and discretional ligatures applied. + * German Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextualDiscretional = "StandardContextualDiscretional", + germanLuxembourg = "GermanLuxembourg", /** - * Historical and discretional ligatures applied. + * Greek language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historicalDiscretional = "HistoricalDiscretional", + greek = "Greek", /** - * Standard, historical, and discretional ligatures applied. + * Guarani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardHistoricalDiscretional = "StandardHistoricalDiscretional", + guarani = "Guarani", /** - * Contextual, historical, and discretional ligatures applied. + * Gujarati language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", + gujarati = "Gujarati", /** - * All ligatures applied. + * Hausa language. * @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 { + hausa = "Hausa", /** - * Represents a mixed light rig type. + * Hawaiian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + hawaiian = "Hawaiian", /** - * Represents legacy flat light rig type 1. + * Hebrew language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat1 = "LegacyFlat1", + hebrew = "Hebrew", /** - * Represents legacy flat light rig type 2. + * Hindi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat2 = "LegacyFlat2", + hindi = "Hindi", /** - * Represents legacy flat light rig type 3. + * Hungarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat3 = "LegacyFlat3", + hungarian = "Hungarian", /** - * Represents legacy flat light rig type 4. + * Ibibio language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat4 = "LegacyFlat4", + ibibio = "Ibibio", /** - * Represents legacy normal light rig type 1. + * Icelandic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal1 = "LegacyNormal1", + icelandic = "Icelandic", /** - * Represents legacy normal light rig type 2. + * Igbo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal2 = "LegacyNormal2", + igbo = "Igbo", /** - * Represents legacy normal light rig type 3. + * Indonesian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal3 = "LegacyNormal3", + indonesian = "Indonesian", /** - * Represents legacy normal light rig type 4. + * Inuktitut language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal4 = "LegacyNormal4", + inuktitut = "Inuktitut", /** - * Represents legacy harsh light rig type 1. + * Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh1 = "LegacyHarsh1", + italian = "Italian", /** - * Represents legacy harsh light rig type 2. + * Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh2 = "LegacyHarsh2", + japanese = "Japanese", /** - * Represents legacy harsh light rig type 3. + * Kannada language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh3 = "LegacyHarsh3", + kannada = "Kannada", /** - * Represents legacy harsh light rig type 4. + * Kanuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh4 = "LegacyHarsh4", + kanuri = "Kanuri", /** - * Represents a three-point light rig type. + * Kashmiri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threePoint = "ThreePoint", + kashmiri = "Kashmiri", /** - * Represents a balanced light rig type. + * Kazakh language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balanced = "Balanced", + kazakh = "Kazakh", /** - * Represents a soft light rig type. + * Khmer language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - soft = "Soft", + khmer = "Khmer", /** - * Represents a harsh light rig type. + * Kirghiz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - harsh = "Harsh", + kirghiz = "Kirghiz", /** - * Represents a flood light rig type. + * Konkani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flood = "Flood", + konkani = "Konkani", /** - * Represents a contrasting light rig type. + * Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contrasting = "Contrasting", + korean = "Korean", /** - * Represents a morning light rig type. + * Kyrgyz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - morning = "Morning", + kyrgyz = "Kyrgyz", /** - * Represents a sunrise light rig type. + * No specified language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunrise = "Sunrise", + languageNone = "LanguageNone", /** - * Represents a sunset light rig type. + * Lao language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunset = "Sunset", + lao = "Lao", /** - * Represents a chilly light rig type. + * Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chilly = "Chilly", + latin = "Latin", /** - * Represents a freezing light rig type. + * Latvian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - freezing = "Freezing", + latvian = "Latvian", /** - * Represents a flat light rig type. + * Lithuanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + lithuanian = "Lithuanian", /** - * Represents a two-point light rig type. + * Macedonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPoint = "TwoPoint", + macedonianFYROM = "MacedonianFYROM", /** - * Represents a glow light rig type. + * Malayalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow = "Glow", + malayalam = "Malayalam", /** - * Represents a bright room light rig type. + * Malay Brunei Darussalam language. * @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 { + malayBruneiDarussalam = "MalayBruneiDarussalam", /** - * Represents a mixed dash style. + * Malaysian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + malaysian = "Malaysian", /** - * Represents a solid line style. + * Maltese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + maltese = "Maltese", /** - * Represents a square dot line style. + * Manipuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareDot = "SquareDot", + manipuri = "Manipuri", /** - * Represents a round dot line style. + * Marathi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - roundDot = "RoundDot", + marathi = "Marathi", /** - * Represents a dashed line style. + * Mexican Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dash = "Dash", + mexicanSpanish = "MexicanSpanish", /** - * Represents a dash-dot line style. + * Mongolian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDot = "DashDot", + mongolian = "Mongolian", /** - * Represents a dash-dot-dot line style. + * Nepali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotDot = "DashDotDot", + nepali = "Nepali", /** - * Represents a long dash line style. + * 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 */ - longDash = "LongDash", + noProofing = "NoProofing", /** - * Represents a long dash-dot line style. + * Norwegian Bokmol language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDot = "LongDashDot", + norwegianBokmol = "NorwegianBokmol", /** - * Represents a long dash-dot-dot line style. + * Norwegian Nynorsk language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDotDot = "LongDashDotDot", + norwegianNynorsk = "NorwegianNynorsk", /** - * Represents a system dash line style. + * Odia (Oriya) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDash = "SysDash", + oriya = "Oriya", /** - * Represents a system dot line style. + * Oromo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDot = "SysDot", + oromo = "Oromo", /** - * Represents a system dash-dot line style. + * Pashto language. * @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 { + pashto = "Pashto", /** - * Represents a mixed line style. + * Persian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + persian = "Persian", /** - * Represents a single line style. + * Polish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + polish = "Polish", /** - * Represents a thin-thin line style. + * Portuguese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThin = "ThinThin", + portuguese = "Portuguese", /** - * Represents a thin-thick line style. + * Portuguese (Brazil) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThick = "ThinThick", + portugueseBrazil = "PortugueseBrazil", /** - * Represents a thick-thin line style. + * Punjabi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThin = "ThickThin", + punjabi = "Punjabi", /** - * Represents a thick line between two thin lines style. + * Rhaeto Romanic language. * @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 { + rhaetoRomanic = "RhaetoRomanic", /** - * Applies the list template to the entire list. + * Romanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wholeList = "WholeList", + romanian = "Romanian", /** - * Applies the list template from the cursor insertion point to the end of the list. + * Romanian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thisPointForward = "ThisPointForward", + romanianMoldova = "RomanianMoldova", /** - * Applies the list template to the selection. + * Russian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selection = "Selection", - } - /** - * Represents the list type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListType { + russian = "Russian", /** - * List with no bullets, numbering, or outlining. + * Russian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNoNumbering = "ListNoNumbering", + russianMoldova = "RussianMoldova", /** - * ListNum fields that can be used in the body of a paragraph. + * Sami Lappish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listListNumOnly = "ListListNumOnly", + samiLappish = "SamiLappish", /** - * Bulleted list. + * Sanskrit language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listBullet = "ListBullet", + sanskrit = "Sanskrit", /** - * Simple numeric list. + * Serbian Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listSimpleNumbering = "ListSimpleNumbering", + serbianCyrillic = "SerbianCyrillic", /** - * Outlined list. + * Serbian Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listOutlineNumbering = "ListOutlineNumbering", + serbianLatin = "SerbianLatin", /** - * Mixed numeric list. + * Sesotho language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listMixedNumbering = "ListMixedNumbering", + sesotho = "Sesotho", /** - * Picture bulleted list. + * Simplified Chinese language. * @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 { + simplifiedChinese = "SimplifiedChinese", /** - * Default number form setting. + * Sindhi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + sindhi = "Sindhi", /** - * Lining number form setting. + * Sindhi (Pakistan) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lining = "Lining", + sindhiPakistan = "SindhiPakistan", /** - * Old-style number form setting. + * Sinhalese language. * @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 { + sinhalese = "Sinhalese", /** - * Default number spacing setting. + * Slovakian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + slovak = "Slovak", /** - * Proportional number spacing setting. + * Slovenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + slovenian = "Slovenian", /** - * Tabular number spacing setting. + * Somali language. * @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 { + somali = "Somali", /** - * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. + * Sorbian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + sorbian = "Sorbian", /** - * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. + * Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNum = "ListNum", + spanish = "Spanish", /** - * Default value for all other cases. + * Spanish Argentina language. * @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 { + spanishArgentina = "SpanishArgentina", /** - * Represents a mixed pattern type. + * Spanish Bolivian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + spanishBolivia = "SpanishBolivia", /** - * Represents a 5 percent fill pattern. + * Spanish Chilean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent5 = "Percent5", + spanishChile = "SpanishChile", /** - * Represents a 10 percent fill pattern. + * Spanish Colombian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent10 = "Percent10", + spanishColombia = "SpanishColombia", /** - * Represents a 20 percent fill pattern. + * Spanish Costa Rican language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent20 = "Percent20", + spanishCostaRica = "SpanishCostaRica", /** - * Represents a 25 percent fill pattern. + * Spanish Dominican Republic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent25 = "Percent25", + spanishDominicanRepublic = "SpanishDominicanRepublic", /** - * Represents a 30 percent fill pattern. + * Spanish Ecuadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent30 = "Percent30", + spanishEcuador = "SpanishEcuador", /** - * Represents a 40 percent fill pattern. + * Spanish El Salvadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent40 = "Percent40", + spanishElSalvador = "SpanishElSalvador", /** - * Represents a 50 percent fill pattern. + * Spanish Guatemala language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent50 = "Percent50", + spanishGuatemala = "SpanishGuatemala", /** - * Represents a 60 percent fill pattern. + * Spanish Honduran language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent60 = "Percent60", + spanishHonduras = "SpanishHonduras", /** - * Represents a 70 percent fill pattern. + * Spanish Modern Sort language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent70 = "Percent70", + spanishModernSort = "SpanishModernSort", /** - * Represents a 75 percent fill pattern. + * Spanish Nicaraguan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent75 = "Percent75", + spanishNicaragua = "SpanishNicaragua", /** - * Represents an 80 percent fill pattern. + * Spanish Panamanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent80 = "Percent80", + spanishPanama = "SpanishPanama", /** - * Represents a 90 percent fill pattern. + * Spanish Paraguayan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent90 = "Percent90", + spanishParaguay = "SpanishParaguay", /** - * Represents a dark horizontal fill pattern. + * Spanish Peruvian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkHorizontal = "DarkHorizontal", + spanishPeru = "SpanishPeru", /** - * Represents a dark vertical fill pattern. + * Spanish Puerto Rican language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkVertical = "DarkVertical", + spanishPuertoRico = "SpanishPuertoRico", /** - * Represents a dark downward diagonal fill pattern. + * Spanish Uruguayan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkDownwardDiagonal = "DarkDownwardDiagonal", + spanishUruguay = "SpanishUruguay", /** - * Represents a dark upward diagonal fill pattern. + * Spanish Venezuelan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkUpwardDiagonal = "DarkUpwardDiagonal", + spanishVenezuela = "SpanishVenezuela", /** - * Represents a small checkerboard fill pattern. + * Sutu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCheckerBoard = "SmallCheckerBoard", + sutu = "Sutu", /** - * Represents a trellis fill pattern. + * Swahili language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - trellis = "Trellis", + swahili = "Swahili", /** - * Represents a light horizontal fill pattern. + * Swedish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightHorizontal = "LightHorizontal", + swedish = "Swedish", /** - * Represents a light vertical fill pattern. + * Swedish Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightVertical = "LightVertical", + swedishFinland = "SwedishFinland", /** - * Represents a light downward diagonal fill pattern. + * Swiss French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightDownwardDiagonal = "LightDownwardDiagonal", + swissFrench = "SwissFrench", /** - * Represents a light upward diagonal fill pattern. + * Swiss German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightUpwardDiagonal = "LightUpwardDiagonal", + swissGerman = "SwissGerman", /** - * Represents a small grid fill pattern. + * Swiss Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallGrid = "SmallGrid", + swissItalian = "SwissItalian", /** - * Represents a dotted diamond fill pattern. + * Syriac language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedDiamond = "DottedDiamond", + syriac = "Syriac", /** - * Represents a wide downward diagonal fill pattern. + * Tajik language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideDownwardDiagonal = "WideDownwardDiagonal", + tajik = "Tajik", /** - * Represents a wide upward diagonal fill pattern. + * Tamazight language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideUpwardDiagonal = "WideUpwardDiagonal", + tamazight = "Tamazight", /** - * Represents a dashed upward diagonal fill pattern. + * Tamazight Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedUpwardDiagonal = "DashedUpwardDiagonal", + tamazightLatin = "TamazightLatin", /** - * Represents a dashed downward diagonal fill pattern. + * Tamil language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedDownwardDiagonal = "DashedDownwardDiagonal", + tamil = "Tamil", /** - * Represents a narrow vertical fill pattern. + * Tatar language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowVertical = "NarrowVertical", + tatar = "Tatar", /** - * Represents a narrow horizontal fill pattern. + * Telugu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowHorizontal = "NarrowHorizontal", + telugu = "Telugu", /** - * Represents a dashed vertical fill pattern. + * Thai language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedVertical = "DashedVertical", + thai = "Thai", /** - * Represents a dashed horizontal fill pattern. + * Tibetan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedHorizontal = "DashedHorizontal", + tibetan = "Tibetan", /** - * Represents a large confetti fill pattern. + * Tigrigna Eritrea language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeConfetti = "LargeConfetti", + tigrignaEritrea = "TigrignaEritrea", /** - * Represents a large grid fill pattern. + * Tigrigna Ethiopic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeGrid = "LargeGrid", + tigrignaEthiopic = "TigrignaEthiopic", /** - * Represents a horizontal brick fill pattern. + * Traditional Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalBrick = "HorizontalBrick", + traditionalChinese = "TraditionalChinese", /** - * Represents a large checkerboard fill pattern. + * Tsonga language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeCheckerBoard = "LargeCheckerBoard", + tsonga = "Tsonga", /** - * Represents a small confetti fill pattern. + * Tswana language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallConfetti = "SmallConfetti", + tswana = "Tswana", /** - * Represents a zigzag fill pattern. + * Turkish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + turkish = "Turkish", /** - * Represents a solid diamond fill pattern. + * Turkmen language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solidDiamond = "SolidDiamond", + turkmen = "Turkmen", /** - * Represents a diagonal brick fill pattern. + * Ukrainian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalBrick = "DiagonalBrick", + ukrainian = "Ukrainian", /** - * Represents an outlined diamond fill pattern. + * Urdu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinedDiamond = "OutlinedDiamond", + urdu = "Urdu", /** - * Represents a plaid fill pattern. + * Uzbek Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plaid = "Plaid", + uzbekCyrillic = "UzbekCyrillic", /** - * Represents a sphere fill pattern. + * Uzbek Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sphere = "Sphere", + uzbekLatin = "UzbekLatin", /** - * Represents a weave fill pattern. + * Venda language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weave = "Weave", + venda = "Venda", /** - * Represents a dotted grid fill pattern. + * Vietnamese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedGrid = "DottedGrid", + vietnamese = "Vietnamese", /** - * Represents a divot fill pattern. + * Welsh language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "Divot", + welsh = "Welsh", /** - * Represents a shingle fill pattern. + * Xhosa language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shingle = "Shingle", + xhosa = "Xhosa", /** - * Represents a wave fill pattern. + * Yi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wave = "Wave", + yi = "Yi", /** - * Represents a horizontal fill pattern. + * Yiddish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + yiddish = "Yiddish", /** - * Represents a vertical fill pattern. + * Yoruba language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + yoruba = "Yoruba", /** - * Represents a cross fill pattern. + * Zulu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "Cross", + zulu = "Zulu", + } + /** + * Specifies how a building block is inserted into a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocPartInsertType { /** - * Represents a downward diagonal fill pattern. + * Inserts the content of the building block. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - downwardDiagonal = "DownwardDiagonal", + content = "Content", /** - * Represents an upward diagonal fill pattern. + * Inserts the building block as a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upwardDiagonal = "UpwardDiagonal", + paragraph = "Paragraph", /** - * Represents a diagonal cross fill pattern. + * Inserts the building block as a page. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalCross = "DiagonalCross", + page = "Page", } /** - * Indicates the effects camera type used by the specified object. + * Specifies the type of building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetCamera { + enum BuildingBlockType { /** - * Represents a mixed camera type. + * Represents Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + quickParts = "QuickParts", /** - * Represents a legacy oblique top-left camera type. + * Represents Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopLeft = "LegacyObliqueTopLeft", + coverPage = "CoverPage", /** - * Represents a legacy oblique top camera type. + * Represents Equations building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTop = "LegacyObliqueTop", + equations = "Equations", /** - * Represents a legacy oblique top-right camera type. + * Represents Footers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopRight = "LegacyObliqueTopRight", + footers = "Footers", /** - * Represents a legacy oblique left camera type. + * Represents Headers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueLeft = "LegacyObliqueLeft", + headers = "Headers", /** - * Represents a legacy oblique front camera type. + * Represents Page Number building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueFront = "LegacyObliqueFront", + pageNumber = "PageNumber", /** - * Represents a legacy oblique right camera type. + * Represents Tables building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueRight = "LegacyObliqueRight", + tables = "Tables", /** - * Represents a legacy oblique bottom-left camera type. + * Represents Watermarks building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", + watermarks = "Watermarks", /** - * Represents a legacy oblique bottom camera type. + * Represents AutoText building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottom = "LegacyObliqueBottom", + autoText = "AutoText", /** - * Represents a legacy oblique bottom-right camera type. + * Represents Text Box building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomRight = "LegacyObliqueBottomRight", + textBox = "TextBox", /** - * Represents a legacy perspective top-left camera type. + * Represents Page Number Top building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", + pageNumberTop = "PageNumberTop", /** - * Represents a legacy perspective top camera type. + * Represents Page Number Bottom building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTop = "LegacyPerspectiveTop", + pageNumberBottom = "PageNumberBottom", /** - * Represents a legacy perspective top-right camera type. + * Represents Page Number Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", + pageNumberPage = "PageNumberPage", /** - * Represents a legacy perspective left camera type. + * Represents Table of Contents building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveLeft = "LegacyPerspectiveLeft", + tableOfContents = "TableOfContents", /** - * Represents a legacy perspective front camera type. + * Represents Custom Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveFront = "LegacyPerspectiveFront", + customQuickParts = "CustomQuickParts", /** - * Represents a legacy perspective right camera type. + * Represents Custom Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveRight = "LegacyPerspectiveRight", + customCoverPage = "CustomCoverPage", /** - * Represents a legacy perspective bottom-left camera type. + * Represents Custom Equations building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", + customEquations = "CustomEquations", /** - * Represents a legacy perspective bottom camera type. + * Represents Custom Footers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottom = "LegacyPerspectiveBottom", + customFooters = "CustomFooters", /** - * Represents a legacy perspective bottom-right camera type. + * Represents Custom Headers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", + customHeaders = "CustomHeaders", /** - * Represents an orthographic front camera type. + * Represents Custom Page Number building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orthographicFront = "OrthographicFront", + customPageNumber = "CustomPageNumber", /** - * Represents an isometric top-up camera type. + * Represents Custom Tables building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopUp = "IsometricTopUp", + customTables = "CustomTables", /** - * Represents an isometric top-down camera type. + * Represents Custom Watermarks building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopDown = "IsometricTopDown", + customWatermarks = "CustomWatermarks", /** - * Represents an isometric bottom-up camera type. + * Represents Custom AutoText building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomUp = "IsometricBottomUp", + customAutoText = "CustomAutoText", /** - * Represents an isometric bottom-down camera type. + * Represents Custom Text Box building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomDown = "IsometricBottomDown", + customTextBox = "CustomTextBox", /** - * Represents an isometric left-up camera type. + * Represents Custom Page Number Top building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftUp = "IsometricLeftUp", + customPageNumberTop = "CustomPageNumberTop", /** - * Represents an isometric left-down camera type. + * Represents Custom Page Number Bottom building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftDown = "IsometricLeftDown", + customPageNumberBottom = "CustomPageNumberBottom", /** - * Represents an isometric right-up camera type. + * Represents Custom Page Number Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightUp = "IsometricRightUp", + customPageNumberPage = "CustomPageNumberPage", /** - * Represents an isometric right-down camera type. + * Represents Custom Table of Contents building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightDown = "IsometricRightDown", + customTableOfContents = "CustomTableOfContents", /** - * Represents an isometric off-axis 1 left camera type. + * Represents Custom building block type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Left = "IsometricOffAxis1Left", + custom1 = "Custom1", /** - * Represents an isometric off-axis 1 right camera type. + * Represents Custom building block type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Right = "IsometricOffAxis1Right", + custom2 = "Custom2", /** - * Represents an isometric off-axis 1 top camera type. + * Represents Custom building block type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Top = "IsometricOffAxis1Top", + custom3 = "Custom3", /** - * Represents an isometric off-axis 2 left camera type. + * Represents Custom building block type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Left = "IsometricOffAxis2Left", + custom4 = "Custom4", /** - * Represents an isometric off-axis 2 right camera type. + * Represents Custom building block type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Right = "IsometricOffAxis2Right", + custom5 = "Custom5", /** - * Represents an isometric off-axis 2 top camera type. + * Represents Bibliography building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Top = "IsometricOffAxis2Top", + bibliography = "Bibliography", /** - * Represents an isometric off-axis 3 left camera type. + * Represents Custom Bibliography building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Left = "IsometricOffAxis3Left", - /** - * Represents an isometric off-axis 3 right camera type. + customBibliography = "CustomBibliography", + } + /** + * Represents the type of a {@link Word.CustomXmlValidationError}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CustomXmlValidationErrorType { + /** + * Represents a validation error generated by the schema. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Right = "IsometricOffAxis3Right", + schemaGenerated = "schemaGenerated", /** - * Represents an isometric off-axis 3 bottom camera type. + * Represents a validation error that is automatically cleared. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", + automaticallyCleared = "automaticallyCleared", /** - * Represents an isometric off-axis 4 left camera type. + * Represents a validation error that is manually created. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Left = "IsometricOffAxis4Left", + manual = "manual", + } + /** + * Represents the type of a {@link Word.CustomXmlNode}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CustomXmlNodeType { /** - * Represents an isometric off-axis 4 right camera type. + * Represents an XML element node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Right = "IsometricOffAxis4Right", + element = "element", /** - * Represents an isometric off-axis 4 bottom camera type. + * Represents an XML attribute node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", + attribute = "attribute", /** - * Represents an oblique top-left camera type. + * Represents an XML text node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopLeft = "ObliqueTopLeft", + text = "text", /** - * Represents an oblique top camera type. + * Represents an XML CDATA section node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTop = "ObliqueTop", + cData = "cData", /** - * Represents an oblique top-right camera type. + * Represents an XML processing instruction node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopRight = "ObliqueTopRight", + processingInstruction = "processingInstruction", /** - * Represents an oblique left camera type. + * Represents an XML comment node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueLeft = "ObliqueLeft", + comment = "comment", /** - * Represents an oblique right camera type. + * Represents an XML document node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueRight = "ObliqueRight", + document = "document", + } + /** + * Represents the list formatting characteristics of a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; /** - * Represents an oblique bottom-left camera type. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomLeft = "ObliqueBottomLeft", + readonly list: Word.List; /** - * Represents an oblique bottom camera type. + * Gets the list template associated with the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottom = "ObliqueBottom", + readonly listTemplate: Word.ListTemplate; /** - * Represents an oblique bottom-right camera type. + * Indicates whether the `ListFormat` object contains a single list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomRight = "ObliqueBottomRight", + readonly isSingleList: boolean; /** - * Represents a perspective front camera type. + * Indicates whether the `ListFormat` object contains a single list template. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveFront = "PerspectiveFront", + readonly isSingleListTemplate: boolean; /** - * Represents a perspective left camera type. + * Specifies the list level number for the first paragraph for the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveLeft = "PerspectiveLeft", + listLevelNumber: number; /** - * Represents a perspective right camera type. + * 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 */ - perspectiveRight = "PerspectiveRight", + readonly listString: string; /** - * Represents a perspective above camera type. + * Gets the type of the list for the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAbove = "PerspectiveAbove", + readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Represents a perspective below camera type. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveBelow = "PerspectiveBelow", + readonly listValue: number; /** - * Represents a perspective above-left facing camera 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. */ - perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", + 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; /** - * Represents a perspective above-right facing camera type. + * 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`. */ - perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", + applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Represents a perspective contrasting-left facing camera type. + * 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`. */ - perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", + applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a perspective contrasting-right facing camera type. + * Applies a list template with a specific level to the paragraphs in the range. + * * @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. */ - perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", + applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; /** - * Represents a perspective heroic-left facing camera type. + * Adds 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. */ - perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", + applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Represents a perspective heroic-right facing camera type. + * Adds 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. */ - perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", + applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a perspective heroic-extreme left facing camera type. + * 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. */ - perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", + applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Represents a perspective heroic-extreme right facing camera type. + * 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. */ - perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", + applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a relaxed perspective camera type. + * 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. */ - perspectiveRelaxed = "PerspectiveRelaxed", + canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; /** - * Represents a moderately relaxed perspective camera type. + * 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. */ - 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 { + convertNumbersToText(numberType: Word.NumberType): void; /** - * Represents a mixed extrusion direction. + * 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. */ - mixed = "Mixed", + convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Represents an extrusion direction to the bottom-right. + * 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. */ - bottomRight = "BottomRight", + countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; /** - * Represents an extrusion direction to the bottom. + * Indents the list by one level. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + listIndent(): void; /** - * Represents an extrusion direction to the bottom-left. + * Outdents the list by one level. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + listOutdent(): void; /** - * Represents an extrusion direction to the right. + * Removes numbering from the list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of number to remove. */ - right = "Right", + removeNumbers(numberType: Word.NumberType): void; /** - * Represents no extrusion direction. + * Removes numbering from the list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of number to remove. */ - none = "None", + removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Represents an extrusion direction to the 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 options Provides options for which properties of the object to load. */ - left = "Left", + load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; /** - * Represents an extrusion direction to the top-right. - * @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. */ - topRight = "TopRight", + load(propertyNames?: string | string[]): Word.ListFormat; /** - * Represents an extrusion direction to the top. + * 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.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.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.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.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.ListFormatData; + } + /** + * Represents options for counting numbered items in a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ListFormatCountNumberedItemsOptions { + /** + * If provided, specifies the level to count. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + level?: number; /** - * Represents an extrusion direction to the top-left. + * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", + numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; } /** - * Specifies which predefined gradient to use to fill a shape. + * Represents options for applying a list template to a range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetGradientType { + interface ListTemplateApplyOptions { /** - * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. + * If provided, specifies the level to apply in the list template. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + applyLevel?: number; /** - * A warm gradient resembling an early sunset. + * 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 */ - earlySunset = "EarlySunset", + applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; /** - * A deeper, richer gradient resembling a late sunset. + * If provided, specifies whether to continue the previous list. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lateSunset = "LateSunset", + continuePreviousList?: boolean; /** - * A dark gradient evoking the colors of nightfall. + * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nightfall = "Nightfall", + 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; /** - * A light gradient representing the colors of daybreak. + * Returns a `ColorFormat` object that represents the background color for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - daybreak = "Daybreak", + readonly backgroundColor: Word.ColorFormat; /** - * A gradient that mimics the colors of the horizon. + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizon = "Horizon", + readonly foregroundColor: Word.ColorFormat; /** - * A warm, sandy gradient inspired by desert tones. + * 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 */ - desert = "Desert", + gradientAngle: number; /** - * A cool gradient reflecting ocean hues. + * Gets the gradient color type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ocean = "Ocean", + readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * A soft, tranquil gradient resembling calm water. + * 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 */ - calmWater = "CalmWater", + readonly gradientDegree: number; /** - * A vivid gradient with fiery tones. + * Returns the gradient style for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fire = "Fire", + readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * A muted gradient with fog-like softness. + * 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 */ - fog = "Fog", + readonly gradientVariant: number; /** - * A natural green gradient inspired by moss. + * Specifies if the object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - moss = "Moss", + isVisible: boolean; /** - * A vibrant gradient with peacock feather colors. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peacock = "Peacock", + 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"; /** - * A light, golden gradient resembling wheat. + * Returns the preset gradient type for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wheat = "Wheat", + 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"; /** - * A warm, aged paper-like gradient. + * Gets the preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + 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"; /** - * A rich, reddish-brown gradient like mahogany wood. + * Specifies whether the fill rotates with the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mahogany = "Mahogany", + rotateWithObject: boolean; /** - * A colorful gradient resembling a rainbow. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbow = "Rainbow", + textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * A variation of the rainbow gradient with different color emphasis. + * Specifies the horizontal scaling factor for the texture fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbowII = "RainbowII", + textureHorizontalScale: number; /** - * A shiny, metallic gold gradient. + * Returns the name of the custom texture file for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gold = "Gold", + readonly textureName: string; /** - * A variation of the gold gradient with different tones. + * Specifies the horizontal offset of the texture from the origin in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - goldII = "GoldII", + textureOffsetX: number; /** - * A metallic gradient resembling brass. + * Specifies the vertical offset of the texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brass = "Brass", + textureOffsetY: number; /** - * A sleek, reflective chrome gradient. + * Specifies whether the texture is tiled. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chrome = "Chrome", + textureTile: boolean; /** - * A variation of the chrome gradient with alternate highlights. + * Returns the texture type for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chromeII = "ChromeII", + readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * A smooth, metallic silver gradient. + * 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 */ - silver = "Silver", + textureVerticalScale: number; /** - * A deep blue gradient inspired by sapphire. + * 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 */ - 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 { + transparency: number; /** - * Represents a mixed lighting direction. + * Gets the fill format type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; /** - * Represents lighting from the top-left. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on 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). */ - topLeft = "TopLeft", + setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; /** - * Represents lighting from the top. + * 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). */ - top = "Top", + setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; /** - * Represents lighting from the top-right. + * Sets the fill to a pattern. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + setPatterned(pattern: Word.PatternType): void; /** - * Represents lighting from the left. + * Sets the fill to a pattern. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + 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; /** - * Represents no lighting. + * 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 */ - none = "None", + setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; /** - * Represents lighting from the right. + * 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 */ - right = "Right", + 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; /** - * Represents lighting from the bottom-left. + * Sets the fill to a preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + setPresetTextured(presetTexture: Word.PresetTexture): void; /** - * Represents lighting from the bottom. + * Sets the fill to a preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + 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; /** - * Represents lighting from the bottom-right. + * Sets the fill to a two-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", + 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.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; } /** - * Specifies the intensity of light used on a shape. + * Represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetLightingSoftness { + 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; /** - * Represents a mixed lighting softness. + * Returns a `ColorFormat` object that represents the color for a glow effect. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly color: Word.ColorFormat; /** - * Represents dim lighting. + * Specifies the length of the radius for a glow effect. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dim = "Dim", + radius: number; /** - * Represents normal lighting. + * 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 */ - normal = "Normal", + transparency: number; /** - * Represents bright lighting. - * @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. */ - bright = "Bright", + 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; + /** + * Queues up a command to load the specified properties 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.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.GlowFormat; + /** + * 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.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.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.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.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.GlowFormatData; } /** - * Specifies the extrusion surface material. + * 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 */ - enum PresetMaterial { + 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; /** - * Represents a mixed material type. + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly backgroundColor: Word.ColorFormat; /** - * Represents a matte material. + * Gets a `ColorFormat` object that represents the foreground color for the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte = "Matte", + readonly foregroundColor: Word.ColorFormat; /** - * Represents a plastic material. + * Specifies the length of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic = "Plastic", + beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Represents a metal material. + * Specifies the style of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal = "Metal", + beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Represents a wireframe material. + * Specifies the width of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wireFrame = "WireFrame", + beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Represents a second matte material. + * Specifies the dash style for the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte2 = "Matte2", + dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Represents a second plastic material. + * Specifies the length of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic2 = "Plastic2", + endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Represents a second metal material. + * Specifies the style of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal2 = "Metal2", + endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Represents a warm matte material. + * Specifies the width of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - warmMatte = "WarmMatte", + endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Represents a translucent powder material. + * Specifies if to draw lines inside a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - translucentPowder = "TranslucentPowder", + insetPen: boolean; /** - * Represents a powder material. + * Specifies if the object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - powder = "Powder", + isVisible: boolean; /** - * Represents a dark edge material. + * Specifies the pattern applied to the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkEdge = "DarkEdge", + 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"; /** - * Represents a soft edge material. + * Specifies the line format style. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softEdge = "SoftEdge", + style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Represents a clear material. + * 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 */ - clear = "Clear", + transparency: number; /** - * Represents a flat material. + * Specifies the thickness of the line in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + weight: number; /** - * Represents a soft metal material. - * @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. */ - softMetal = "SoftMetal", + 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.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.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?: { + 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.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.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.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.LineFormatData; } /** - * Specifies texture to be used to fill a shape. + * Represents the reflection formatting for a shape in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetTexture { - /** - * Represents a mixed texture type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - mixed = "Mixed", + 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; /** - * Represents a papyrus texture. + * 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 */ - papyrus = "Papyrus", + blur: number; /** - * Represents a canvas texture. + * Specifies the amount of separation, in points, of the reflected image from the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canvas = "Canvas", + offset: number; /** - * Represents a denim texture. + * 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 */ - denim = "Denim", + size: number; /** - * Represents a woven mat texture. + * 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 */ - wovenMat = "WovenMat", + transparency: number; /** - * Represents a water droplets texture. + * 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 */ - waterDroplets = "WaterDroplets", + type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; /** - * Represents a paper bag texture. - * @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. */ - paperBag = "PaperBag", + 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; /** - * Represents a fish fossil texture. - * @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. */ - fishFossil = "FishFossil", + load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; /** - * Represents a sand texture. - * @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. */ - sand = "Sand", + load(propertyNames?: string | string[]): Word.ReflectionFormat; /** - * Represents a green marble texture. - * @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. */ - greenMarble = "GreenMarble", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ReflectionFormat; /** - * Represents a white marble texture. - * @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. */ - whiteMarble = "WhiteMarble", + track(): Word.ReflectionFormat; /** - * Represents a brown marble texture. - * @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. */ - brownMarble = "BrownMarble", + untrack(): Word.ReflectionFormat; /** - * Represents a granite texture. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - granite = "Granite", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + */ + 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; /** - * Represents a newsprint texture. + * 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 */ - newsprint = "Newsprint", + brightness: number; /** - * Represents a recycled paper texture. + * Specifies the theme color for a color format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - recycledPaper = "RecycledPaper", + objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Represents a parchment texture. + * 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 */ - parchment = "Parchment", + rgb: string; /** - * Represents a stationery texture. + * 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 */ - stationery = "Stationery", + tintAndShade: number; /** - * Represents a blue tissue paper texture. + * Returns the shape color type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blueTissuePaper = "BlueTissuePaper", + readonly type: Word.ColorType | "rgb" | "scheme"; /** - * Represents a pink tissue paper texture. - * @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. */ - pinkTissuePaper = "PinkTissuePaper", + 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; /** - * Represents a purple mesh texture. - * @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. */ - purpleMesh = "PurpleMesh", + load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; /** - * Represents a bouquet texture. - * @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. */ - bouquet = "Bouquet", + load(propertyNames?: string | string[]): Word.ColorFormat; /** - * Represents a cork texture. - * @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. */ - cork = "Cork", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ColorFormat; /** - * Represents a walnut texture. - * @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. */ - walnut = "Walnut", + track(): Word.ColorFormat; /** - * Represents an oak texture. - * @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. */ - oak = "Oak", + untrack(): Word.ColorFormat; /** - * Represents a medium wood texture. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - mediumWood = "MediumWood", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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 an extrusion (three-dimensional) format. + * Represents the shadow formatting for a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetThreeDimensionalFormat { + 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; /** - * Represents a mixed three-dimensional format. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly foregroundColor: Word.ColorFormat; /** - * Represents three-dimensional format 1. + * 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 */ - format1 = "Format1", + blur: number; /** - * Represents three-dimensional format 2. + * Specifies whether the object or the formatting applied to it is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format2 = "Format2", + isVisible: boolean; /** - * Represents three-dimensional format 3. + * 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 */ - format3 = "Format3", + obscured: boolean; /** - * Represents three-dimensional format 4. + * 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 */ - format4 = "Format4", + offsetX: number; /** - * Represents three-dimensional format 5. + * 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 */ - format5 = "Format5", + offsetY: number; /** - * Represents three-dimensional format 6. + * Specifies whether to rotate the shadow when rotating the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format6 = "Format6", + rotateWithShape: boolean; /** - * Represents three-dimensional format 7. + * Specifies the width of the shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format7 = "Format7", + size: number; /** - * Represents three-dimensional format 8. + * Specifies the type of shadow formatting to apply to a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format8 = "Format8", + style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Represents three-dimensional format 9. + * 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 */ - format9 = "Format9", + transparency: number; /** - * Represents three-dimensional format 10. + * Specifies the shape shadow type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format10 = "Format10", + 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"; /** - * Represents three-dimensional format 11. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - format11 = "Format11", - /** - * Represents three-dimensional format 12. - * @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. */ - format12 = "Format12", + 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; /** - * Represents three-dimensional format 13. + * 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 */ - format13 = "Format13", + incrementOffsetX(increment: number): void; /** - * Represents three-dimensional format 14. + * 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 */ - format14 = "Format14", + incrementOffsetY(increment: number): void; /** - * Represents three-dimensional format 15. - * @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. */ - format15 = "Format15", + load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; /** - * Represents three-dimensional format 16. - * @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. */ - format16 = "Format16", + load(propertyNames?: string | string[]): Word.ShadowFormat; /** - * Represents three-dimensional format 17. - * @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. */ - format17 = "Format17", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShadowFormat; /** - * Represents three-dimensional format 18. - * @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. */ - format18 = "Format18", + track(): Word.ShadowFormat; /** - * Represents three-dimensional format 19. - * @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. */ - format19 = "Format19", + untrack(): Word.ShadowFormat; /** - * Represents three-dimensional format 20. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - format20 = "Format20", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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 type of the {@link Word.ReflectionFormat} object. + * Represents a shape's three-dimensional formatting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ReflectionType { + 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; /** - * Represents a mixed reflection type. + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly contourColor: Word.ColorFormat; /** - * Represents no reflection. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + readonly extrusionColor: Word.ColorFormat; /** - * Represents reflection type 1. + * Specifies the depth of the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + bevelBottomDepth: number; /** - * Represents reflection type 2. + * Specifies the inset size for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + bevelBottomInset: number; /** - * Represents reflection type 3. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Represents reflection type 4. + * Specifies the depth of the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + bevelTopDepth: number; /** - * Represents reflection type 5. + * Specifies the inset size for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + bevelTopInset: number; /** - * Represents reflection type 6. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Represents reflection type 7. + * Specifies the width of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + contourWidth: number; /** - * Represents reflection type 8. + * Specifies the depth of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + depth: number; /** - * Represents reflection type 9. + * 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 */ - type9 = "Type9", - } - /** - * Specifies the type of shadowing effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowStyle { + extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Represents a mixed shadow style. + * Specifies the amount of perspective for a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + fieldOfView: number; /** - * Represents an outer shadow style. + * 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 */ - outerShadow = "OuterShadow", + isPerspective: boolean; /** - * Represents an inner shadow style. + * Specifies if the specified object, or the formatting applied to it, is visible. + * * @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 { + isVisible: boolean; /** - * Represents a mixed shadow type. + * Specifies the angle of the lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + lightAngle: number; /** - * Represents shadow type 1. + * Returns a `PresetCamera` value that represents the camera presets. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + 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"; /** - * Represents shadow type 2. + * 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 */ - type2 = "Type2", + readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Represents shadow type 3. + * Specifies a `LightRigType` value that represents the lighting preset. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + 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"; /** - * Represents shadow type 4. + * Specifies the position of the light source relative to the extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Represents shadow type 5. + * Specifies the intensity of the extrusion lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Represents shadow type 6. + * Specifies the extrusion surface material. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Represents shadow type 7. + * Returns the preset extrusion format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + 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"; /** - * Represents shadow type 8. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + projectText: boolean; /** - * Represents shadow type 9. + * Specifies the rotation of the extruded shape around the x-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", + rotationX: number; /** - * Represents shadow type 10. + * Specifies the rotation of the extruded shape around the y-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type10 = "Type10", + rotationY: number; /** - * Represents shadow type 11. + * Specifies the z-axis rotation of the camera. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type11 = "Type11", + rotationZ: number; /** - * Represents shadow type 12. + * Specifies the position on the z-axis for the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type12 = "Type12", + z: number; /** - * Represents shadow type 13. - * @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. */ - type13 = "Type13", + 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; /** - * Represents shadow type 14. + * Horizontally rotates a shape on the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type14 = "Type14", + incrementRotationHorizontal(increment: number): void; /** - * Represents shadow type 15. + * Vertically rotates a shape on the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type15 = "Type15", + incrementRotationVertical(increment: number): void; /** - * Represents shadow type 16. + * Changes the rotation around the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type16 = "Type16", + incrementRotationX(increment: number): void; /** - * Represents shadow type 17. + * Changes the rotation around the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type17 = "Type17", + incrementRotationY(increment: number): void; /** - * Represents shadow type 18. + * Rotates a shape on the z-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type18 = "Type18", + incrementRotationZ(increment: number): void; /** - * Represents shadow type 19. + * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type19 = "Type19", + resetRotation(): void; /** - * Represents shadow type 20. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection The preset direction. */ - type20 = "Type20", + setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; /** - * Represents shadow type 21. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection The preset direction. */ - type21 = "Type21", + setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; /** - * Represents shadow type 22. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type22 = "Type22", + setPresetCamera(presetCamera: Word.PresetCamera): void; /** - * Represents shadow type 23. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type23 = "Type23", + 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; /** - * Represents shadow type 24. + * Sets the preset extrusion format. + The preset format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type24 = "Type24", + setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; /** - * Represents shadow type 25. + * Sets the preset extrusion format. + The preset format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type25 = "Type25", + setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void; /** - * Represents shadow type 26. - * @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. */ - type26 = "Type26", + load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; /** - * Represents shadow type 27. - * @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. */ - type27 = "Type27", + load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat; /** - * Represents shadow type 28. - * @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. */ - type28 = "Type28", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ThreeDimensionalFormat; /** - * Represents shadow type 29. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object 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 length of the arrowhead at the end of a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ArrowheadLength { + /** + * Represents a mixed arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type29 = "Type29", + mixed = "Mixed", /** - * Represents shadow type 30. + * Represents a short arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type30 = "Type30", + short = "Short", /** - * Represents shadow type 31. + * Represents a medium arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type31 = "Type31", + medium = "Medium", /** - * Represents shadow type 32. + * Represents a long arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type32 = "Type32", + long = "Long", + } + /** + * Specifies the style of the arrowhead at the end of a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ArrowheadStyle { /** - * Represents shadow type 33. + * Represents a mixed arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type33 = "Type33", + mixed = "Mixed", /** - * Represents shadow type 34. + * Represents no arrowhead. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type34 = "Type34", + none = "None", /** - * Represents shadow type 35. + * Represents a triangle arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type35 = "Type35", + triangle = "Triangle", /** - * Represents shadow type 36. + * Represents an open arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type36 = "Type36", + open = "Open", /** - * Represents shadow type 37. + * Represents a stealth arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type37 = "Type37", + stealth = "Stealth", /** - * Represents shadow type 38. + * Represents a diamond arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type38 = "Type38", + diamond = "Diamond", /** - * Represents shadow type 39. + * Represents an oval arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type39 = "Type39", + oval = "Oval", + } + /** + * Specifies the width of the arrowhead at the end of a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ArrowheadWidth { /** - * Represents shadow type 40. + * Represents a mixed arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type40 = "Type40", + mixed = "Mixed", /** - * Represents shadow type 41. + * Represents a narrow arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type41 = "Type41", + narrow = "Narrow", /** - * Represents shadow type 42. + * Represents a medium arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type42 = "Type42", + medium = "Medium", /** - * Represents shadow type 43. + * Represents a wide arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type43 = "Type43", + wide = "Wide", } /** - * Specifies the stylistic set to apply to the font. + * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum StylisticSet { + enum BevelType { /** - * Default stylistic set. + * Represents a mixed bevel type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + mixed = "mixed", /** - * Stylistic set 01. + * Represents no bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set01 = "Set01", + none = "none", /** - * Stylistic set 02. + * Represents a relaxed inset bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set02 = "Set02", + relaxedInset = "relaxedInset", /** - * Stylistic set 03. + * Represents a circle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set03 = "Set03", + circle = "circle", /** - * Stylistic set 04. + * Represents a slope bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set04 = "Set04", + slope = "slope", /** - * Stylistic set 05. + * Represents a cross bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set05 = "Set05", + cross = "cross", /** - * Stylistic set 06. + * Represents an angle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set06 = "Set06", + angle = "angle", /** - * Stylistic set 07. + * Represents a soft round bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set07 = "Set07", + softRound = "softRound", /** - * Stylistic set 08. + * Represents a convex bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set08 = "Set08", + convex = "convex", /** - * Stylistic set 09. + * Represents a cool slant bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set09 = "Set09", + coolSlant = "coolSlant", /** - * Stylistic set 10. + * Represents a divot bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set10 = "Set10", + divot = "divot", /** - * Stylistic set 11. + * Represents a riblet bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set11 = "Set11", + riblet = "riblet", /** - * Stylistic set 12. + * Represents a hard edge bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set12 = "Set12", + hardEdge = "hardEdge", /** - * Stylistic set 13. + * Represents an art deco bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set13 = "Set13", + artDeco = "artDeco", + } + /** + * Represents color index values in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColorIndex { /** - * Stylistic set 14. + * Automatically determines the color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set14 = "Set14", + auto = "Auto", /** - * Stylistic set 15. + * Represents the color black. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set15 = "Set15", + black = "Black", /** - * Stylistic set 16. + * Represents the color blue. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set16 = "Set16", + blue = "Blue", /** - * Stylistic set 17. + * Represents the color turquoise. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set17 = "Set17", + turquoise = "Turquoise", /** - * Stylistic set 18. + * Represents a bright green color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set18 = "Set18", + brightGreen = "BrightGreen", /** - * Stylistic set 19. + * Represents the color pink. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set19 = "Set19", + pink = "Pink", /** - * Stylistic set 20. + * Represents the color red. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set20 = "Set20", + red = "Red", + /** + * Represents the color yellow. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + yellow = "Yellow", + /** + * Represents the color white. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + white = "White", + /** + * Represents a dark blue color. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + darkBlue = "DarkBlue", + /** + * Represents the color teal. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + teal = "Teal", + /** + * Represents the color green. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + green = "Green", + /** + * Represents the color violet. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + violet = "Violet", + /** + * Represents a dark red color. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Specifies the color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextureAlignment { + enum ColorType { /** - * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. + * Represents an RGB color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + rgb = "rgb", /** - * Aligns the texture to the top-left corner of the shape. + * Represents a scheme color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", + scheme = "scheme", + } + /** + * Specifies whether the formatting from the previous list can be continued. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Continue { /** - * Aligns the texture to the top center of the shape. + * Formatting cannot continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + disabled = "Disabled", /** - * Aligns the texture to the top-right corner of the shape. + * Formatting can continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + list = "List", /** - * Aligns the texture to the middle left side of the shape. + * Numbering can be restarted. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + reset = "Reset", + } + /** + * Specifies the default list behavior for a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DefaultListBehavior { /** - * Aligns the texture to the center of the shape. + * Use formatting compatible with Microsoft Word 97. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + word97 = "Word97", /** - * Aligns the texture to the middle right side of the shape. + * Use Web-oriented formatting as introduced in Microsoft Word 2000. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + word2000 = "Word2000", /** - * Aligns the texture to the bottom-left corner of the shape. + * Use formatting compatible with Microsoft Word 2002. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + 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 { /** - * Aligns the texture to the bottom center of the shape. + * No emphasis mark. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + none = "None", /** - * Aligns the texture to the bottom-right corner of the shape. + * Emphasis mark over a solid circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", + overSolidCircle = "OverSolidCircle", + /** + * Emphasis mark over a comma. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + overComma = "OverComma", + /** + * Emphasis mark over a white circle. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + overWhiteCircle = "OverWhiteCircle", + /** + * Emphasis mark under a solid circle. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underSolidCircle = "UnderSolidCircle", } /** - * Specifies the texture type for the selected fill. + * 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 TextureType { + enum ExtrusionColorType { /** - * Mixed texture type. Used when multiple shapes with different texture types are selected. + * Represents a mixed extrusion color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + mixed = "mixed", /** - * A predefined texture selected from the built-in texture gallery. + * Represents an automatic extrusion color based on the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preset = "Preset", + automatic = "automatic", /** - * A custom texture defined by the user, typically from an image file. + * Represents a custom extrusion color independent of the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - userDefined = "UserDefined", + custom = "custom", } /** - * Specifies the theme colors for document themes. + * Specifies a shape's fill type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ThemeColorIndex { + enum FillType { /** - * Not a theme color. Used when the color is not part of the theme. + * Represents a mixed fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - notThemeColor = "NotThemeColor", + mixed = "Mixed", /** - * The first dark color in the main theme. + * Represents a solid fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark1 = "MainDark1", + solid = "Solid", /** - * The first light color in the main theme. + * Represents a patterned fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight1 = "MainLight1", + patterned = "Patterned", /** - * The second dark color in the main theme. + * Represents a gradient fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark2 = "MainDark2", + gradient = "Gradient", /** - * The second light color in the main theme. + * Represents a textured fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight2 = "MainLight2", + textured = "Textured", /** - * The first accent color in the theme. + * Represents a background fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent1 = "Accent1", + background = "Background", /** - * The second accent color in the theme. + * Represents a picture fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent2 = "Accent2", + picture = "Picture", + } + /** + * Specifies the type of gradient used in a shape's fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GradientColorType { /** - * The third accent color in the theme. + * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent3 = "Accent3", + mixed = "Mixed", /** - * The fourth accent color in the theme. + * Gradient with a single color and varying transparency or brightness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent4 = "Accent4", + oneColor = "OneColor", /** - * The fifth accent color in the theme. + * Gradient that blends two distinct colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent5 = "Accent5", + twoColors = "TwoColors", /** - * The sixth accent color in the theme. + * Gradient that uses a predefined set of colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent6 = "Accent6", + presetColors = "PresetColors", /** - * The color used for hyperlinks. + * Gradient that includes more than two colors, often customized. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlink = "Hyperlink", + multiColor = "MultiColor", + } + /** + * Specifies the style for a gradient fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GradientStyle { /** - * The color used for followed hyperlinks. + * Represents a mixed gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinkFollowed = "HyperlinkFollowed", + mixed = "Mixed", /** - * The first background color in the theme. + * Represents a horizontal gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background1 = "Background1", + horizontal = "Horizontal", /** - * The first text color in the theme. + * Represents a vertical gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text1 = "Text1", + vertical = "Vertical", /** - * The second background color in the theme. + * Represents a diagonal-up gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background2 = "Background2", + diagonalUp = "DiagonalUp", /** - * The second text color in the theme. + * Represents a diagonal-down gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text2 = "Text2", + diagonalDown = "DiagonalDown", + /** + * Represents a gradient style from the corner. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fromCorner = "FromCorner", + /** + * Represents a gradient style from the title. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fromTitle = "FromTitle", + /** + * Represents a gradient style from the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fromCenter = "FromCenter", } /** - * Specifies the hyperlink type. + * Specifies the type of ligature applied to a font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum HyperlinkType { + enum Ligature { /** - * Represents a hyperlink to a range in the document. + * No ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range = "Range", + none = "None", /** - * Represents a hyperlink to a shape in the document. + * Standard ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shape = "Shape", + standard = "Standard", /** - * Represents a hyperlink to an inline shape in the document. + * Contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inlineShape = "InlineShape", - } - enum ErrorCodes { - accessDenied = "AccessDenied", - generalException = "GeneralException", - invalidArgument = "InvalidArgument", - itemNotFound = "ItemNotFound", - notAllowed = "NotAllowed", - notImplemented = "NotImplemented", - searchDialogIsOpen = "SearchDialogIsOpen", - searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + contextual = "Contextual", + /** + * Standard and contextual ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standardContextual = "StandardContextual", + /** + * Historical ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + historical = "Historical", + /** + * Standard and historical ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standardHistorical = "StandardHistorical", + /** + * Contextual and historical ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contextualHistorical = "ContextualHistorical", + /** + * Standard, contextual, and historical ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standardContextualHistorical = "StandardContextualHistorical", + /** + * Discretional ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + discretional = "Discretional", + /** + * Standard and discretional ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standardDiscretional = "StandardDiscretional", + /** + * Contextual and discretional ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contextualDiscretional = "ContextualDiscretional", + /** + * Standard, contextual, and discretional ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standardContextualDiscretional = "StandardContextualDiscretional", + /** + * Historical and discretional ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + historicalDiscretional = "HistoricalDiscretional", + /** + * Standard, historical, and discretional ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standardHistoricalDiscretional = "StandardHistoricalDiscretional", + /** + * Contextual, historical, and discretional ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", + /** + * All ligatures applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + all = "All", } - namespace Interfaces { + /** + * Indicates the effects lighting for an object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LightRigType { /** - * Provides ways to load properties of only a subset of members of a collection. + * Represents a mixed light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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({ ... })`. */ - interface AnnotationCollectionUpdateData { - items?: Word.Interfaces.AnnotationData[]; - } - /** 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. - * + mixed = "Mixed", + /** + * Represents legacy flat light rig type 1. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyFlat1 = "LegacyFlat1", + /** + * Represents legacy flat light rig type 2. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyFlat2 = "LegacyFlat2", + /** + * Represents legacy flat light rig type 3. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyFlat3 = "LegacyFlat3", + /** + * Represents legacy flat light rig type 4. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyFlat4 = "LegacyFlat4", + /** + * Represents legacy normal light rig type 1. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyNormal1 = "LegacyNormal1", + /** + * Represents legacy normal light rig type 2. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyNormal2 = "LegacyNormal2", + /** + * Represents legacy normal light rig type 3. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyNormal3 = "LegacyNormal3", + /** + * Represents legacy normal light rig type 4. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyNormal4 = "LegacyNormal4", + /** + * Represents legacy harsh light rig type 1. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyHarsh1 = "LegacyHarsh1", + /** + * Represents legacy harsh light rig type 2. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyHarsh2 = "LegacyHarsh2", + /** + * Represents legacy harsh light rig type 3. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyHarsh3 = "LegacyHarsh3", + /** + * Represents legacy harsh light rig type 4. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyHarsh4 = "LegacyHarsh4", + /** + * Represents a three-point light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threePoint = "ThreePoint", + /** + * Represents a balanced light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + balanced = "Balanced", + /** + * Represents a soft light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + soft = "Soft", + /** + * Represents a harsh light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + harsh = "Harsh", + /** + * Represents a flood light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + flood = "Flood", + /** + * Represents a contrasting light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contrasting = "Contrasting", + /** + * Represents a morning light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + morning = "Morning", + /** + * Represents a sunrise light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sunrise = "Sunrise", + /** + * Represents a sunset light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sunset = "Sunset", + /** + * Represents a chilly light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chilly = "Chilly", + /** + * Represents a freezing light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + freezing = "Freezing", + /** + * Represents a flat light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + flat = "Flat", + /** + * Represents a two-point light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + twoPoint = "TwoPoint", + /** + * Represents a glow light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + glow = "Glow", + /** + * Represents a bright room light rig type. + * @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 { + /** + * Represents a mixed dash style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents a solid line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + solid = "Solid", + /** + * Represents a square dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + squareDot = "SquareDot", + /** + * Represents a round dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + roundDot = "RoundDot", + /** + * Represents a dashed line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dash = "Dash", + /** + * Represents a dash-dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashDot = "DashDot", + /** + * Represents a dash-dot-dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashDotDot = "DashDotDot", + /** + * Represents a long dash line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + longDash = "LongDash", + /** + * Represents a long dash-dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + longDashDot = "LongDashDot", + /** + * Represents a long dash-dot-dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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", + } + /** + * Specifies the style for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineFormatStyle { + /** + * Represents a mixed line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents a single line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + single = "Single", + /** + * Represents a thin-thin line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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", + } + /** + * Specifies the portion of a list to which to apply a list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListApplyTo { + /** + * Applies the list template to the entire list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wholeList = "WholeList", + /** + * Applies the list template from the cursor insertion point to the end of the list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thisPointForward = "ThisPointForward", + /** + * Applies the list template to the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selection = "Selection", + } + /** + * Represents the list type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListType { + /** + * List with no bullets, numbering, or outlining. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listNoNumbering = "ListNoNumbering", + /** + * ListNum fields that can be used in the body of a paragraph. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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", + } + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberForm { + /** + * Default number form setting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Lining number form setting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lining = "Lining", + /** + * Old-style number form setting. + * @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 { + /** + * Default number spacing setting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Proportional number spacing setting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + proportional = "Proportional", + /** + * Tabular number spacing setting. + * @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 { + /** + * 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 + */ + paragraph = "Paragraph", + /** + * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listNum = "ListNum", + /** + * Default value for all other cases. + * @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 { + /** + * Represents a mixed pattern type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents a 5 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent5 = "Percent5", + /** + * Represents a 10 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent10 = "Percent10", + /** + * Represents a 20 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent20 = "Percent20", + /** + * Represents a 25 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent25 = "Percent25", + /** + * Represents a 30 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent30 = "Percent30", + /** + * Represents a 40 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent40 = "Percent40", + /** + * Represents a 50 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent50 = "Percent50", + /** + * Represents a 60 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent60 = "Percent60", + /** + * Represents a 70 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent70 = "Percent70", + /** + * Represents a 75 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent75 = "Percent75", + /** + * Represents an 80 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent80 = "Percent80", + /** + * Represents a 90 percent fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent90 = "Percent90", + /** + * Represents a dark horizontal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + darkHorizontal = "DarkHorizontal", + /** + * Represents a dark vertical fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + darkVertical = "DarkVertical", + /** + * Represents a dark downward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + darkDownwardDiagonal = "DarkDownwardDiagonal", + /** + * Represents a dark upward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + darkUpwardDiagonal = "DarkUpwardDiagonal", + /** + * Represents a small checkerboard fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallCheckerBoard = "SmallCheckerBoard", + /** + * Represents a trellis fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trellis = "Trellis", + /** + * Represents a light horizontal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lightHorizontal = "LightHorizontal", + /** + * Represents a light vertical fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lightVertical = "LightVertical", + /** + * Represents a light downward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lightDownwardDiagonal = "LightDownwardDiagonal", + /** + * Represents a light upward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lightUpwardDiagonal = "LightUpwardDiagonal", + /** + * Represents a small grid fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallGrid = "SmallGrid", + /** + * Represents a dotted diamond fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dottedDiamond = "DottedDiamond", + /** + * Represents a wide downward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wideDownwardDiagonal = "WideDownwardDiagonal", + /** + * Represents a wide upward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wideUpwardDiagonal = "WideUpwardDiagonal", + /** + * Represents a dashed upward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashedUpwardDiagonal = "DashedUpwardDiagonal", + /** + * Represents a dashed downward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashedDownwardDiagonal = "DashedDownwardDiagonal", + /** + * Represents a narrow vertical fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + narrowVertical = "NarrowVertical", + /** + * Represents a narrow horizontal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + narrowHorizontal = "NarrowHorizontal", + /** + * Represents a dashed vertical fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashedVertical = "DashedVertical", + /** + * Represents a dashed horizontal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashedHorizontal = "DashedHorizontal", + /** + * Represents a large confetti fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + largeConfetti = "LargeConfetti", + /** + * Represents a large grid fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + largeGrid = "LargeGrid", + /** + * Represents a horizontal brick fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalBrick = "HorizontalBrick", + /** + * Represents a large checkerboard fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + largeCheckerBoard = "LargeCheckerBoard", + /** + * Represents a small confetti fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallConfetti = "SmallConfetti", + /** + * Represents a zigzag fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + zigZag = "ZigZag", + /** + * Represents a solid diamond fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + solidDiamond = "SolidDiamond", + /** + * Represents a diagonal brick fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + diagonalBrick = "DiagonalBrick", + /** + * Represents an outlined diamond fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlinedDiamond = "OutlinedDiamond", + /** + * Represents a plaid fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + plaid = "Plaid", + /** + * Represents a sphere fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sphere = "Sphere", + /** + * Represents a weave fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + weave = "Weave", + /** + * Represents a dotted grid fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dottedGrid = "DottedGrid", + /** + * Represents a divot fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + divot = "Divot", + /** + * Represents a shingle fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shingle = "Shingle", + /** + * Represents a wave fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wave = "Wave", + /** + * Represents a horizontal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontal = "Horizontal", + /** + * Represents a vertical fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vertical = "Vertical", + /** + * Represents a cross fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cross = "Cross", + /** + * Represents a downward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + downwardDiagonal = "DownwardDiagonal", + /** + * Represents an upward diagonal fill pattern. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upwardDiagonal = "UpwardDiagonal", + /** + * Represents a diagonal cross fill pattern. + * @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 { + /** + * Represents a mixed camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents a legacy oblique top-left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueTopLeft = "LegacyObliqueTopLeft", + /** + * Represents a legacy oblique top camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueTop = "LegacyObliqueTop", + /** + * Represents a legacy oblique top-right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueTopRight = "LegacyObliqueTopRight", + /** + * Represents a legacy oblique left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueLeft = "LegacyObliqueLeft", + /** + * Represents a legacy oblique front camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueFront = "LegacyObliqueFront", + /** + * Represents a legacy oblique right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueRight = "LegacyObliqueRight", + /** + * Represents a legacy oblique bottom-left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", + /** + * Represents a legacy oblique bottom camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueBottom = "LegacyObliqueBottom", + /** + * Represents a legacy oblique bottom-right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyObliqueBottomRight = "LegacyObliqueBottomRight", + /** + * Represents a legacy perspective top-left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", + /** + * Represents a legacy perspective top camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveTop = "LegacyPerspectiveTop", + /** + * Represents a legacy perspective top-right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", + /** + * Represents a legacy perspective left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveLeft = "LegacyPerspectiveLeft", + /** + * Represents a legacy perspective front camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveFront = "LegacyPerspectiveFront", + /** + * Represents a legacy perspective right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveRight = "LegacyPerspectiveRight", + /** + * Represents a legacy perspective bottom-left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", + /** + * Represents a legacy perspective bottom camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveBottom = "LegacyPerspectiveBottom", + /** + * Represents a legacy perspective bottom-right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", + /** + * Represents an orthographic front camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + orthographicFront = "OrthographicFront", + /** + * Represents an isometric top-up camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricTopUp = "IsometricTopUp", + /** + * Represents an isometric top-down camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricTopDown = "IsometricTopDown", + /** + * Represents an isometric bottom-up camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricBottomUp = "IsometricBottomUp", + /** + * Represents an isometric bottom-down camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricBottomDown = "IsometricBottomDown", + /** + * Represents an isometric left-up camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricLeftUp = "IsometricLeftUp", + /** + * Represents an isometric left-down camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricLeftDown = "IsometricLeftDown", + /** + * Represents an isometric right-up camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricRightUp = "IsometricRightUp", + /** + * Represents an isometric right-down camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricRightDown = "IsometricRightDown", + /** + * Represents an isometric off-axis 1 left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis1Left = "IsometricOffAxis1Left", + /** + * Represents an isometric off-axis 1 right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis1Right = "IsometricOffAxis1Right", + /** + * Represents an isometric off-axis 1 top camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis1Top = "IsometricOffAxis1Top", + /** + * Represents an isometric off-axis 2 left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis2Left = "IsometricOffAxis2Left", + /** + * Represents an isometric off-axis 2 right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis2Right = "IsometricOffAxis2Right", + /** + * Represents an isometric off-axis 2 top camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis2Top = "IsometricOffAxis2Top", + /** + * Represents an isometric off-axis 3 left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis3Left = "IsometricOffAxis3Left", + /** + * Represents an isometric off-axis 3 right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis3Right = "IsometricOffAxis3Right", + /** + * Represents an isometric off-axis 3 bottom camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", + /** + * Represents an isometric off-axis 4 left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis4Left = "IsometricOffAxis4Left", + /** + * Represents an isometric off-axis 4 right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis4Right = "IsometricOffAxis4Right", + /** + * Represents an isometric off-axis 4 bottom camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", + /** + * Represents an oblique top-left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obliqueTopLeft = "ObliqueTopLeft", + /** + * Represents an oblique top camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obliqueTop = "ObliqueTop", + /** + * Represents an oblique top-right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obliqueTopRight = "ObliqueTopRight", + /** + * Represents an oblique left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obliqueLeft = "ObliqueLeft", + /** + * Represents an oblique right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obliqueRight = "ObliqueRight", + /** + * Represents an oblique bottom-left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obliqueBottomLeft = "ObliqueBottomLeft", + /** + * Represents an oblique bottom camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obliqueBottom = "ObliqueBottom", + /** + * Represents an oblique bottom-right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obliqueBottomRight = "ObliqueBottomRight", + /** + * Represents a perspective front camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveFront = "PerspectiveFront", + /** + * Represents a perspective left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveLeft = "PerspectiveLeft", + /** + * Represents a perspective right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveRight = "PerspectiveRight", + /** + * Represents a perspective above camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveAbove = "PerspectiveAbove", + /** + * Represents a perspective below camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveBelow = "PerspectiveBelow", + /** + * Represents a perspective above-left facing camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", + /** + * Represents a perspective above-right facing camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", + /** + * Represents a perspective contrasting-left facing camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", + /** + * Represents a perspective contrasting-right facing camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", + /** + * Represents a perspective heroic-left facing camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", + /** + * Represents a perspective heroic-right facing camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", + /** + * Represents a perspective heroic-extreme left facing camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", + /** + * Represents a perspective heroic-extreme right facing camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", + /** + * Represents a relaxed perspective camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + perspectiveRelaxed = "PerspectiveRelaxed", + /** + * Represents a moderately relaxed perspective camera type. + * @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 { + /** + * Represents a mixed extrusion direction. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents an extrusion direction to the bottom-right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomRight = "BottomRight", + /** + * Represents an extrusion direction to the bottom. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottom = "Bottom", + /** + * Represents an extrusion direction to the bottom-left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomLeft = "BottomLeft", + /** + * Represents an extrusion direction to the right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * Represents no extrusion direction. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents an extrusion direction to the left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * Represents an extrusion direction to the top-right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topRight = "TopRight", + /** + * Represents an extrusion direction to the top. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + /** + * Represents an extrusion direction to the top-left. + * @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 { + /** + * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * A warm gradient resembling an early sunset. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + earlySunset = "EarlySunset", + /** + * A deeper, richer gradient resembling a late sunset. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lateSunset = "LateSunset", + /** + * A dark gradient evoking the colors of nightfall. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nightfall = "Nightfall", + /** + * A light gradient representing the colors of daybreak. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + daybreak = "Daybreak", + /** + * A gradient that mimics the colors of the horizon. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizon = "Horizon", + /** + * A warm, sandy gradient inspired by desert tones. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + desert = "Desert", + /** + * A cool gradient reflecting ocean hues. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ocean = "Ocean", + /** + * A soft, tranquil gradient resembling calm water. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + calmWater = "CalmWater", + /** + * A vivid gradient with fiery tones. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fire = "Fire", + /** + * A muted gradient with fog-like softness. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fog = "Fog", + /** + * A natural green gradient inspired by moss. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + moss = "Moss", + /** + * A vibrant gradient with peacock feather colors. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + peacock = "Peacock", + /** + * A light, golden gradient resembling wheat. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wheat = "Wheat", + /** + * A warm, aged paper-like gradient. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parchment = "Parchment", + /** + * A rich, reddish-brown gradient like mahogany wood. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mahogany = "Mahogany", + /** + * A colorful gradient resembling a rainbow. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rainbow = "Rainbow", + /** + * A variation of the rainbow gradient with different color emphasis. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rainbowII = "RainbowII", + /** + * A shiny, metallic gold gradient. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gold = "Gold", + /** + * A variation of the gold gradient with different tones. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + goldII = "GoldII", + /** + * A metallic gradient resembling brass. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + brass = "Brass", + /** + * A sleek, reflective chrome gradient. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chrome = "Chrome", + /** + * A variation of the chrome gradient with alternate highlights. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chromeII = "ChromeII", + /** + * A smooth, metallic silver gradient. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + silver = "Silver", + /** + * A deep blue gradient inspired by sapphire. + * @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 { + /** + * Represents a mixed lighting direction. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents lighting from the top-left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topLeft = "TopLeft", + /** + * Represents lighting from the top. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + /** + * Represents lighting from the top-right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topRight = "TopRight", + /** + * Represents lighting from the left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * Represents no lighting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents lighting from the right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * Represents lighting from the bottom-left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomLeft = "BottomLeft", + /** + * Represents lighting from the bottom. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottom = "Bottom", + /** + * Represents lighting from the bottom-right. + * @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 { + /** + * Represents a mixed lighting softness. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents dim lighting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dim = "Dim", + /** + * Represents normal lighting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents bright lighting. + * @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 { + /** + * Represents a mixed material type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents a matte material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + matte = "Matte", + /** + * Represents a plastic material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + plastic = "Plastic", + /** + * Represents a metal material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + metal = "Metal", + /** + * Represents a wireframe material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wireFrame = "WireFrame", + /** + * Represents a second matte material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + matte2 = "Matte2", + /** + * Represents a second plastic material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + plastic2 = "Plastic2", + /** + * Represents a second metal material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + metal2 = "Metal2", + /** + * Represents a warm matte material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + warmMatte = "WarmMatte", + /** + * Represents a translucent powder material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + translucentPowder = "TranslucentPowder", + /** + * Represents a powder material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + powder = "Powder", + /** + * Represents a dark edge material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + darkEdge = "DarkEdge", + /** + * Represents a soft edge material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + softEdge = "SoftEdge", + /** + * Represents a clear material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clear = "Clear", + /** + * Represents a flat material. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + flat = "Flat", + /** + * Represents a soft metal material. + * @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 { + /** + * Represents a mixed texture type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents a papyrus texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + papyrus = "Papyrus", + /** + * Represents a canvas texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + canvas = "Canvas", + /** + * Represents a denim texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + denim = "Denim", + /** + * Represents a woven mat texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wovenMat = "WovenMat", + /** + * Represents a water droplets texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + waterDroplets = "WaterDroplets", + /** + * Represents a paper bag texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paperBag = "PaperBag", + /** + * Represents a fish fossil texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fishFossil = "FishFossil", + /** + * Represents a sand texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sand = "Sand", + /** + * Represents a green marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + greenMarble = "GreenMarble", + /** + * Represents a white marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + whiteMarble = "WhiteMarble", + /** + * Represents a brown marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + brownMarble = "BrownMarble", + /** + * Represents a granite texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + granite = "Granite", + /** + * Represents a newsprint texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newsprint = "Newsprint", + /** + * Represents a recycled paper texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + recycledPaper = "RecycledPaper", + /** + * Represents a parchment texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parchment = "Parchment", + /** + * Represents a stationery texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stationery = "Stationery", + /** + * Represents a blue tissue paper texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + blueTissuePaper = "BlueTissuePaper", + /** + * Represents a pink tissue paper texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pinkTissuePaper = "PinkTissuePaper", + /** + * Represents a purple mesh texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + purpleMesh = "PurpleMesh", + /** + * Represents a bouquet texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bouquet = "Bouquet", + /** + * Represents a cork texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cork = "Cork", + /** + * Represents a walnut texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + walnut = "Walnut", + /** + * Represents an oak texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oak = "Oak", + /** + * Represents a medium wood texture. + * @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 { + /** + * Represents a mixed three-dimensional format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents three-dimensional format 1. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format1 = "Format1", + /** + * Represents three-dimensional format 2. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format2 = "Format2", + /** + * Represents three-dimensional format 3. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format3 = "Format3", + /** + * Represents three-dimensional format 4. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format4 = "Format4", + /** + * Represents three-dimensional format 5. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format5 = "Format5", + /** + * Represents three-dimensional format 6. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format6 = "Format6", + /** + * Represents three-dimensional format 7. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format7 = "Format7", + /** + * Represents three-dimensional format 8. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format8 = "Format8", + /** + * Represents three-dimensional format 9. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format9 = "Format9", + /** + * Represents three-dimensional format 10. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format10 = "Format10", + /** + * Represents three-dimensional format 11. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format11 = "Format11", + /** + * Represents three-dimensional format 12. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format12 = "Format12", + /** + * Represents three-dimensional format 13. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format13 = "Format13", + /** + * Represents three-dimensional format 14. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format14 = "Format14", + /** + * Represents three-dimensional format 15. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format15 = "Format15", + /** + * Represents three-dimensional format 16. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format16 = "Format16", + /** + * Represents three-dimensional format 17. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format17 = "Format17", + /** + * Represents three-dimensional format 18. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format18 = "Format18", + /** + * Represents three-dimensional format 19. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format19 = "Format19", + /** + * Represents three-dimensional format 20. + * @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 { + /** + * Represents a mixed reflection type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents no reflection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents reflection type 1. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type1 = "Type1", + /** + * Represents reflection type 2. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type2 = "Type2", + /** + * Represents reflection type 3. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type3 = "Type3", + /** + * Represents reflection type 4. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type4 = "Type4", + /** + * Represents reflection type 5. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type5 = "Type5", + /** + * Represents reflection type 6. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type6 = "Type6", + /** + * Represents reflection type 7. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type7 = "Type7", + /** + * Represents reflection type 8. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type8 = "Type8", + /** + * Represents reflection type 9. + * @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 { + /** + * Represents a mixed shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents an outer shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outerShadow = "OuterShadow", + /** + * Represents an inner shadow style. + * @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 { + /** + * Represents a mixed shadow type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents shadow type 1. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type1 = "Type1", + /** + * Represents shadow type 2. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type2 = "Type2", + /** + * Represents shadow type 3. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type3 = "Type3", + /** + * Represents shadow type 4. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type4 = "Type4", + /** + * Represents shadow type 5. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type5 = "Type5", + /** + * Represents shadow type 6. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type6 = "Type6", + /** + * Represents shadow type 7. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type7 = "Type7", + /** + * Represents shadow type 8. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type8 = "Type8", + /** + * Represents shadow type 9. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type9 = "Type9", + /** + * Represents shadow type 10. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type10 = "Type10", + /** + * Represents shadow type 11. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type11 = "Type11", + /** + * Represents shadow type 12. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type12 = "Type12", + /** + * Represents shadow type 13. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type13 = "Type13", + /** + * Represents shadow type 14. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type14 = "Type14", + /** + * Represents shadow type 15. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type15 = "Type15", + /** + * Represents shadow type 16. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type16 = "Type16", + /** + * Represents shadow type 17. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type17 = "Type17", + /** + * Represents shadow type 18. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type18 = "Type18", + /** + * Represents shadow type 19. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type19 = "Type19", + /** + * Represents shadow type 20. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type20 = "Type20", + /** + * Represents shadow type 21. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type21 = "Type21", + /** + * Represents shadow type 22. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type22 = "Type22", + /** + * Represents shadow type 23. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type23 = "Type23", + /** + * Represents shadow type 24. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type24 = "Type24", + /** + * Represents shadow type 25. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type25 = "Type25", + /** + * Represents shadow type 26. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type26 = "Type26", + /** + * Represents shadow type 27. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type27 = "Type27", + /** + * Represents shadow type 28. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type28 = "Type28", + /** + * Represents shadow type 29. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type29 = "Type29", + /** + * Represents shadow type 30. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type30 = "Type30", + /** + * Represents shadow type 31. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type31 = "Type31", + /** + * Represents shadow type 32. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type32 = "Type32", + /** + * Represents shadow type 33. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type33 = "Type33", + /** + * Represents shadow type 34. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type34 = "Type34", + /** + * Represents shadow type 35. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type35 = "Type35", + /** + * Represents shadow type 36. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type36 = "Type36", + /** + * Represents shadow type 37. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type37 = "Type37", + /** + * Represents shadow type 38. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type38 = "Type38", + /** + * Represents shadow type 39. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type39 = "Type39", + /** + * Represents shadow type 40. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type40 = "Type40", + /** + * Represents shadow type 41. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type41 = "Type41", + /** + * Represents shadow type 42. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type42 = "Type42", + /** + * Represents shadow type 43. + * @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 { + /** + * Default stylistic set. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Stylistic set 01. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set01 = "Set01", + /** + * Stylistic set 02. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set02 = "Set02", + /** + * Stylistic set 03. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set03 = "Set03", + /** + * Stylistic set 04. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set04 = "Set04", + /** + * Stylistic set 05. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set05 = "Set05", + /** + * Stylistic set 06. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set06 = "Set06", + /** + * Stylistic set 07. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set07 = "Set07", + /** + * Stylistic set 08. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set08 = "Set08", + /** + * Stylistic set 09. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set09 = "Set09", + /** + * Stylistic set 10. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set10 = "Set10", + /** + * Stylistic set 11. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set11 = "Set11", + /** + * Stylistic set 12. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set12 = "Set12", + /** + * Stylistic set 13. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set13 = "Set13", + /** + * Stylistic set 14. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set14 = "Set14", + /** + * Stylistic set 15. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set15 = "Set15", + /** + * Stylistic set 16. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set16 = "Set16", + /** + * Stylistic set 17. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set17 = "Set17", + /** + * Stylistic set 18. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set18 = "Set18", + /** + * Stylistic set 19. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + set19 = "Set19", + /** + * Stylistic set 20. + * @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 { + /** + * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Aligns the texture to the top-left corner of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topLeft = "TopLeft", + /** + * Aligns the texture to the top center of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + /** + * Aligns the texture to the top-right corner of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topRight = "TopRight", + /** + * Aligns the texture to the middle left side of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * Aligns the texture to the center of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Aligns the texture to the middle right side of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * Aligns the texture to the bottom-left corner of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomLeft = "BottomLeft", + /** + * Aligns the texture to the bottom center of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottom = "Bottom", + /** + * Aligns the texture to the bottom-right corner of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomRight = "BottomRight", + } + /** + * Specifies the texture type for the selected fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextureType { + /** + * Mixed texture type. Used when multiple shapes with different texture types are selected. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * A predefined texture selected from the built-in texture gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + preset = "Preset", + /** + * A custom texture defined by the user, typically from an image file. + * @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", + /** + * The first dark color in the main theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainDark1 = "MainDark1", + /** + * The first light color in the main theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainLight1 = "MainLight1", + /** + * The second dark color in the main theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainDark2 = "MainDark2", + /** + * The second light color in the main theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainLight2 = "MainLight2", + /** + * The first accent color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + accent1 = "Accent1", + /** + * The second accent color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + accent2 = "Accent2", + /** + * The third accent color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + accent3 = "Accent3", + /** + * The fourth accent color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + accent4 = "Accent4", + /** + * The fifth accent color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + accent5 = "Accent5", + /** + * The sixth accent color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + accent6 = "Accent6", + /** + * The color used for hyperlinks. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyperlink = "Hyperlink", + /** + * The color used for followed hyperlinks. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyperlinkFollowed = "HyperlinkFollowed", + /** + * The first background color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + background1 = "Background1", + /** + * The first text color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text1 = "Text1", + /** + * The second background color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + background2 = "Background2", + /** + * The second text color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text2 = "Text2", + } + /** + * Specifies the hyperlink type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HyperlinkType { + /** + * Represents a hyperlink to a range in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range = "Range", + /** + * Represents a hyperlink to a shape in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shape = "Shape", + /** + * Represents a hyperlink to an inline shape in the document. + * @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 + */ + 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; + /** + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sources: Word.SourceCollection; + /** + * Specifies the name of the active style to use for the bibliography. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliographyStyle: 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.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; + /** + * 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 + */ + 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. + */ + load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; + /** + * Queues up a command to load the specified properties of the object. You must 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.Bibliography; + /** + * 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.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. + */ + 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[]; + /** + * 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. + */ + add(xml: string): Word.Source; + /** + * 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. + */ + getItem(index: number): Word.Source; + /** + * Queues up a command to load the specified properties 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.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; + /** + * Queues up a command to load the specified properties of the object. You must 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.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; + } + /** + * 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; + /** + * Gets if the `Source` object has been cited in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isCited: boolean; + /** + * Gets the tag of the source. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tag: string; + /** + * Gets the XML representation of the source. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly xml: string; + /** + * Deletes the `Source` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * 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. + */ + 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.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.Source; + /** + * 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.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.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.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.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.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; + /** + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineNumbering: Word.LineNumbering; + /** + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly textColumns: Word.TextColumnCollection; + /** + * Specifies whether Microsoft Word prints the document as a booklet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookFoldPrinting: boolean; + /** + * Specifies the number of pages for each booklet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookFoldPrintingSheets: number; + /** + * 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 + */ + bookFoldReversePrinting: boolean; + /** + * 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 + */ + bottomMargin: number; + /** + * Specifies the number of characters per line in the document grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + charsLine: number; + /** + * Specifies whether the first page has a different header and footer. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + differentFirstPageHeaderFooter: boolean; + /** + * Specifies the distance between the footer and the bottom of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footerDistance: number; + /** + * 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 + */ + gutter: number; + /** + * Specifies on which side the gutter appears in a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; + /** + * 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 + */ + gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; + /** + * Specifies the distance between the header and the top of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + headerDistance: number; + /** + * Specifies the layout mode for the current document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + /** + * 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 + */ + leftMargin: number; + /** + * Specifies the number of lines per page in the document grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linesPage: number; + /** + * Specifies if the inside and outside margins of facing pages are the same width. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mirrorMargins: boolean; + /** + * Specifies whether odd and even pages have different headers and footers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddAndEvenPagesHeaderFooter: boolean; + /** + * Specifies the orientation of the page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + orientation: Word.PageOrientation | "Portrait" | "Landscape"; + /** + * Specifies the page height in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageHeight: number; + /** + * Specifies the page width in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageWidth: number; + /** + * Specifies the paper size of the page. + * + * @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"; + /** + * 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 + */ + rightMargin: number; + /** + * Specifies the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + /** + * Specifies the type of section break for the specified object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + /** + * Specifies whether to show the grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showGrid: boolean; + /** + * 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 + */ + suppressEndnotes: boolean; + /** + * Specifies the top margin of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topMargin: number; + /** + * Specifies whether to print two pages per sheet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + twoPagesOnOne: boolean; + /** + * Specifies the vertical alignment of text on each page in a document or section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; + /** + * 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 + */ + 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.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; + } + /** + * Represents line numbers in the left margin or to the left of each newspaper-style column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isActive: 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + /** + * Specifies the starting line number. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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.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; + } + /** + * 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 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 `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. + */ + add(options?: Word.TextColumnAddOptions): Word.TextColumn; + /** + * Gets the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFlowDirection(): OfficeExtension.ClientResult; + /** + * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getHasLineBetween(): OfficeExtension.ClientResult; + /** + * Gets whether text columns are evenly spaced. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getIsEvenlySpaced(): OfficeExtension.ClientResult; + /** + * Gets a `TextColumn` 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 `TextColumn` object. + */ + getItem(index: number): Word.TextColumn; + /** + * 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. + */ + setCount(numColumns: number): void; + /** + * 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. + */ + setFlowDirection(value: Word.FlowDirection): void; + /** + * 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. + */ + setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; + /** + * 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. + */ + setHasLineBetween(value: boolean): void; + /** + * 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. + */ + 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.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.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?: 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 + */ + 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 + */ + 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spacing?: 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. + * + * @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. + * + * @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.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.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.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 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", + } + 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 `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 `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 `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 { + /** + * 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 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 whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenateCaps?: boolean; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @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 { + /** + * 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 `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + interface HyperlinkUpdateData { + /** + * 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 + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the address (for example, a file name or URL) of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + address?: string; + /** + * Specifies the text string for the hyperlink's subject line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emailSubject?: string; + /** + * 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 + */ + screenTip?: string; + /** + * Specifies a named location in the destination of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subAddress?: string; + /** + * Specifies the name of the frame or window in which to load the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + target?: string; + /** + * Specifies the hyperlink's visible text in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textToDisplay?: string; + } + /** 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 { + /** + * 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({ ... })`. */ + interface InlinePictureCollectionUpdateData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** 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 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({ ... })`. */ + 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; + /** + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the name of the style that's linked to the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + linkedStyle?: string; + /** + * Specifies the number format for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberFormat?: string; + /** + * Specifies the position (in points) of the number or bullet for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberPosition?: number; + /** + * Specifies the number style for the list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + 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 list level that must appear before the specified list level restarts numbering at 1. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + resetOnHigher?: number; + /** + * Specifies the starting number for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + startAt?: number; + /** + * Specifies the tab position for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + 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 `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ + interface ListLevelCollectionUpdateData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ + interface ListTemplateUpdateData { + /** + * Specifies whether the specified ListTemplate object is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; + } + /** 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 `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ + interface NoteItemCollectionUpdateData { + items?: Word.Interfaces.NoteItemData[]; + } + /** 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 `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 { + /** + * 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; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; + /** + * 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({ ... })`. */ + interface ParagraphCollectionUpdateData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ + 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({ ... })`. */ + 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; + /** + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listFormat?: Word.Interfaces.ListFormatUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the proofing status (spelling and grammar checking) of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasNoProofing?: 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. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink?: string; + /** + * 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 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({ ... })`. */ + interface RangeCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ + 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({ ... })`. */ + 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; + /** + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Specifies if the section is protected for forms. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + protectedForForms?: boolean; + } + /** 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 `Setting` object, for use in `setting.set({ ... })`. */ + 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({ ... })`. */ + 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 { + /** + * Specifies a BorderCollection object that represents all the borders for the specified style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderCollectionUpdateData; + /** + * Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + frame?: Word.Interfaces.FrameUpdateData; + /** + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linkStyle?: Word.Interfaces.StyleUpdateData; + /** + * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + listTemplate?: Word.Interfaces.ListTemplateUpdateData; + /** + * 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 whether the style is automatically redefined based on the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + automaticallyUpdate?: boolean; + /** + * 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 whether the spelling and grammar checker ignores text formatted with this style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasProofing?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the style. + * + * @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 style. + * + * @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 whether the style cannot be changed or edited. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + locked?: 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?: string; + /** + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSpaceBetweenParagraphsOfSameStyle?: boolean; + /** + * 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({ ... })`. */ + 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; + /** + * 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: WordApiDesktop 1.1] + */ + foregroundPatternColor?: 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}. + * + * @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"; + } + /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ + interface ShadingUniversalUpdateData { + /** + * 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 + */ + backgroundPatternColor?: string; + /** + * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * + * @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"; + /** + * 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 + */ + 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. + * + * @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"; + /** + * 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 + */ + 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 { + /** + * 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({ ... })`. */ + interface TableStyleUpdateData { + /** + * Specifies the table's alignment against the page margin. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies whether lines in tables formatted with a specified style break across pages. + * + * @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; + /** + * 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({ ... })`. */ + 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 + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * 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 + */ + preferredWidth?: number; + /** + * Specifies the preferred unit of measurement to use for the width of the table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + /** + * Specifies the width of the column, in points. + * + * @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 `TableRow` object, for use in `tableRow.set({ ... })`. */ + 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({ ... })`. */ + interface TableRowCollectionUpdateData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ + 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({ ... })`. */ + interface TableCellCollectionUpdateData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ + 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 `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 + */ + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + /** + * Specifies the line break control level for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + /** + * Specifies whether the spelling and grammar checker ignores documents based on this template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasNoProofing?: boolean; + /** + * Specifies the character spacing adjustment for the template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + /** + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kerningByAlgorithm?: boolean; + /** + * Specifies a `LanguageId` value that represents the language in the template. + * + * @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 language in the template. + * + * @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 the kinsoku characters after which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLineBreakAfter?: string; + /** + * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLineBreakBefore?: string; + /** + * 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 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 `Shape` object, for use in `shape.set({ ... })`. */ + interface ShapeUpdateData { + /** + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * 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: WordApiDesktop 1.2] + */ + canvas?: Word.Interfaces.CanvasUpdateData; + /** + * Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + fill?: Word.Interfaces.ShapeFillUpdateData; + /** + * 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: WordApiDesktop 1.2] + */ + parentCanvas?: Word.Interfaces.ShapeUpdateData; + /** + * 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: WordApiDesktop 1.2] + */ + parentGroup?: Word.Interfaces.ShapeUpdateData; + /** + * 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: WordApiDesktop 1.2] + */ + shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + /** + * Gets the text frame object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + textFrame?: Word.Interfaces.TextFrameUpdateData; + /** + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + /** + * Specifies whether a given shape can overlap other shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + allowOverlap?: boolean; + /** + * Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + altTextDescription?: string; + /** + * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + 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"; + /** + * The height, in points, of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + height?: 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. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative?: number; + /** + * 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: 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. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftRelative?: number; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + lockAspectRatio?: boolean; + /** + * The name of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + name?: string; + /** + * 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: 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}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * 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: WordApiDesktop 1.2] + */ + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * 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: WordApiDesktop 1.2] + */ + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rotation?: number; + /** + * 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: WordApiDesktop 1.2] + */ + top?: 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. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + 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 `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ + interface ShapeGroupUpdateData { + /** + * Gets the Shape object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shape?: Word.Interfaces.ShapeUpdateData; + } + /** 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 `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 { + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + backgroundColor?: string; + /** + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + foregroundColor?: 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. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + transparency?: number; + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + interface TextFrameUpdateData { + /** + * 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: WordApiDesktop 1.2] + */ + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + bottomMargin?: number; + /** + * 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"; + /** + * Determines whether lines break automatically to fit text inside the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + wordWrap?: boolean; + } + /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ + interface ShapeTextWrapUpdateData { + /** + * 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: WordApiDesktop 1.2] + */ + bottomDistance?: number; + /** + * 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: WordApiDesktop 1.2] + */ + leftDistance?: number; + /** + * 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: WordApiDesktop 1.2] + */ + rightDistance?: number; + /** + * 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: 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. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topDistance?: number; + /** + * 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 `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ + interface RepeatingSectionItemUpdateData { + /** + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ + interface DatePickerContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * 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.RangeUpdateData; + /** + * 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.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * 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?: string; + /** + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + /** + * Specifies the format in which dates are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateDisplayFormat?: string; + /** + * 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 + */ + 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 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 + */ + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + /** + * 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; + /** + * 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 a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: string; + } + /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ + interface PictureContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * 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.RangeUpdateData; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * 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?: string; + /** + * 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; + /** + * 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 a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @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 { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * 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.RangeUpdateData; + /** + * 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.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * 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?: string; + /** + * 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; + /** + * 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 a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: string; + } + /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ + interface BuildingBlockGalleryContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * 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.RangeUpdateData; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies the category for the building block content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockCategory?: string; + /** + * 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?: 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 BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * 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; + /** + * 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 a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: string; + } + /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ + interface RepeatingSectionContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * 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.RangeUpdateData; + /** + * 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.XmlMappingUpdateData; + /** + * 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?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * 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?: string; + /** + * 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; + /** + * 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?: string; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: string; + } + /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ + interface FrameUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the height (in points) of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: number; + /** + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + /** + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalDistanceFromText?: number; + /** + * 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 + */ + horizontalPosition?: number; + /** + * Specifies if the frame is locked. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockAnchor?: boolean; + /** + * Specifies the relative horizontal position of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies the relative vertical position of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies if document text wraps around the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textWrap?: boolean; + /** + * Specifies the vertical distance (in points) between the frame and the surrounding text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalDistanceFromText?: number; + /** + * 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 + */ + verticalPosition?: number; + /** + * Specifies the width (in points) of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + /** + * Specifies the rule used to determine the width of the frame. + * + * @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[]; + } + /** 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 { + /** + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listTemplate?: Word.Interfaces.ListTemplateUpdateData; + /** + * Specifies the list level number for the first paragraph for the `ListFormat` object. + * + * @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 { + /** + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * 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 + */ + gradientAngle?: number; + /** + * Specifies if the object, or the formatting applied to it, is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies whether the fill rotates with the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rotateWithObject?: boolean; + /** + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + /** + * Specifies the horizontal scaling factor for the texture fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureHorizontalScale?: number; + /** + * Specifies the horizontal offset of the texture from the origin in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureOffsetX?: number; + /** + * Specifies the vertical offset of the texture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureOffsetY?: number; + /** + * Specifies whether the texture is tiled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureTile?: boolean; + /** + * 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 + */ + textureVerticalScale?: number; + /** + * 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 + */ + transparency?: number; + } + /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ + interface GlowFormatUpdateData { + /** + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: Word.Interfaces.ColorFormatUpdateData; + /** + * Specifies the length of the radius for a glow effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + radius?: 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 + */ + transparency?: number; + } + /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ + interface LineFormatUpdateData { + /** + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Specifies the length of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + /** + * Specifies the style of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + /** + * Specifies the width of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + weight?: number; + } + /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ + interface ReflectionFormatUpdateData { + /** + * 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 + */ + blur?: number; + /** + * Specifies the amount of separation, in points, of the reflected image from the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + offset?: number; + /** + * 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 + */ + size?: number; + /** + * 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 + */ + transparency?: number; + /** + * 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 + */ + 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 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 + */ + brightness?: number; + /** + * Specifies the theme color for a color format. + * + * @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"; + /** + * 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 + */ + rgb?: string; + /** + * 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 + */ + tintAndShade?: number; + } + /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ + interface ShadowFormatUpdateData { + /** + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * 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 + */ + blur?: number; + /** + * Specifies whether the object or the formatting applied to it is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + obscured?: 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + offsetX?: number; + /** + * 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 + */ + offsetY?: number; + /** + * Specifies whether to rotate the shadow when rotating the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rotateWithShape?: boolean; + /** + * Specifies the width of the shadow. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size?: number; + /** + * Specifies the type of shadow formatting to apply to a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + /** + * 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 + */ + transparency?: number; + /** + * Specifies the shape shadow type. + * + * @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 for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ + interface ThreeDimensionalFormatUpdateData { + /** + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contourColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Specifies the depth of the bottom bevel. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bevelBottomDepth?: number; + /** + * Specifies the inset size for the bottom bevel. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bevelBottomInset?: number; + /** + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * + * @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"; + /** + * Specifies the depth of the top bevel. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bevelTopDepth?: number; + /** + * Specifies the inset size for the top bevel. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bevelTopInset?: number; + /** + * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * + * @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"; + /** + * Specifies the width of the contour of a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contourWidth?: number; + /** + * Specifies the depth of the shape's extrusion. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + depth?: 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + /** + * Specifies the amount of perspective for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldOfView?: number; + /** + * 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 + */ + isPerspective?: boolean; + /** + * Specifies if the specified object, or the formatting applied to it, is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies the angle of the lighting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lightAngle?: number; + /** + * Specifies a `LightRigType` value that represents the lighting preset. + * + * @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"; + /** + * Specifies the position of the light source relative to the extrusion. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + /** + * Specifies the intensity of the extrusion lighting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + /** + * Specifies the extrusion surface material. + * + * @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"; + /** + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + projectText?: boolean; + /** + * Specifies the rotation of the extruded shape around the x-axis in degrees. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rotationX?: number; + /** + * Specifies the rotation of the extruded shape around the y-axis in degrees. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rotationY?: number; + /** + * Specifies the z-axis rotation of the camera. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rotationZ?: number; + /** + * Specifies the position on the z-axis for the shape. + * + * @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 { + /** + * Specifies the name of the active style to use for the bibliography. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 { + /** + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineNumbering?: Word.Interfaces.LineNumberingUpdateData; + /** + * Specifies whether Microsoft Word prints the document as a booklet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookFoldPrinting?: boolean; + /** + * Specifies the number of pages for each booklet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookFoldPrintingSheets?: number; + /** + * 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 + */ + bookFoldReversePrinting?: boolean; + /** + * 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 + */ + bottomMargin?: number; + /** + * Specifies the number of characters per line in the document grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + charsLine?: number; + /** + * Specifies whether the first page has a different header and footer. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + differentFirstPageHeaderFooter?: boolean; + /** + * Specifies the distance between the footer and the bottom of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footerDistance?: number; + /** + * 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 + */ + gutter?: number; + /** + * Specifies on which side the gutter appears in a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + /** + * 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 + */ + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + /** + * Specifies the distance between the header and the top of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + headerDistance?: number; + /** + * Specifies the layout mode for the current document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + /** + * 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 + */ + leftMargin?: number; + /** + * Specifies the number of lines per page in the document grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linesPage?: number; + /** + * Specifies if the inside and outside margins of facing pages are the same width. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mirrorMargins?: boolean; + /** + * Specifies whether odd and even pages have different headers and footers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddAndEvenPagesHeaderFooter?: boolean; + /** + * Specifies the orientation of the page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + /** + * Specifies the page height in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageHeight?: number; + /** + * Specifies the page width in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageWidth?: number; + /** + * Specifies the paper size of the page. + * + * @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"; + /** + * 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 + */ + rightMargin?: number; + /** + * Specifies the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + /** + * Specifies the type of section break for the specified object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + /** + * Specifies whether to show the grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showGrid?: boolean; + /** + * 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 + */ + suppressEndnotes?: boolean; + /** + * Specifies the top margin of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topMargin?: number; + /** + * Specifies whether to print two pages per sheet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + twoPagesOnOne?: boolean; + /** + * Specifies the vertical alignment of text on each page in a document or section. + * + * @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 { + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isActive?: 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + /** + * Specifies the starting line number. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + startingNumber?: number; + } + /** 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 { + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + } + /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ + 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()`. */ + 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()`. */ + interface AnnotationCollectionData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface describing the data returned by calling `application.toJSON()`. */ + interface ApplicationData { + /** + * 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.BibliographyData; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + checkLanguage?: boolean; + /** + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * + * @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 { + /** + * 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 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 describing the data returned by calling `border.toJSON()`. */ + interface BorderData { + /** + * 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; + /** + * Gets the location of the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + /** + * 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 + */ + 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"; + /** + * Returns `true` if an inside border can be applied to the specified object. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + inside?: 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. + * Specifies whether the border is visible. * * @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 `Border` object, for use in `border.set({ ... })`. */ - interface BorderUpdateData { + isVisible?: boolean; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the line style of the border. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + 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 border type for the border. + * Specifies the line width of an object's border. * * @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"; + 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 whether the border is visible. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies the width for the border. + * Returns the page number on which the break occurs. * * @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"; + pageIndex?: number; } - /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ - interface BorderCollectionUpdateData { + /** 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 { /** - * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the description for the building block. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideBorderColor?: string; + description?: string; /** - * Specifies the border type of the inside borders. + * Returns the internal identification number for the building block. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + id?: string; /** - * Specifies the width of the inside borders. + * Returns the position of this building block in a collection. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + index?: number; /** - * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outsideBorderColor?: string; + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; /** - * Specifies the border type of the outside borders. + * Specifies the name of the building block. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + name?: string; /** - * Specifies the width of the outside borders. + * Specifies the contents of the building block. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - items?: Word.Interfaces.BorderData[]; + value?: string; } - /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ - interface BreakUpdateData { + /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ + interface BuildingBlockCategoryData { /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + index?: number; + /** + * Returns the name of the `BuildingBlockCategory` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; } - /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ - interface BreakCollectionUpdateData { - items?: Word.Interfaces.BreakData[]; + /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ + interface BuildingBlockTypeItemData { + /** + * Returns the position of an item in a collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + index?: number; + /** + * Returns the localized name of a building block type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; } - /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ - interface CheckboxContentControlUpdateData { + /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ + interface CheckboxContentControlData { /** * Specifies the current state of the checkbox. * @@ -122953,15 +134663,36 @@ declare namespace Word { */ isChecked?: boolean; } - /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ - interface CommentUpdateData { + /** An interface describing the data returned by calling `comment.toJSON()`. */ + interface CommentData { /** - * Specifies the comment's content range. + * 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] */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + 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. * @@ -122969,6 +134700,20 @@ declare namespace Word { * [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. * @@ -122977,12 +134722,12 @@ declare namespace Word { */ resolved?: boolean; } - /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ - interface CommentCollectionUpdateData { + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + interface CommentCollectionData { items?: Word.Interfaces.CommentData[]; } - /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ - interface CommentContentRangeUpdateData { + /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ + interface CommentContentRangeData { /** * Specifies a value that indicates whether the comment text is bold. * @@ -122997,6 +134742,13 @@ declare namespace Word { * [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. * @@ -123011,6 +134763,13 @@ declare namespace Word { * [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. * @@ -123019,22 +134778,36 @@ declare namespace Word { */ 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 { + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + interface CommentReplyData { /** - * Specifies the commentReply's content range. + * 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] */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + authorEmail?: string; /** - * Gets the parent comment of this reply. + * Gets the name of the comment reply's author. * * @remarks * [Api set: WordApi 1.4] */ - parentComment?: Word.Interfaces.CommentUpdateData; + authorName?: string; /** * Specifies the comment reply's content. The string is plain text. * @@ -123042,13 +134815,27 @@ declare namespace Word { * [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 for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ - interface CommentReplyCollectionUpdateData { + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + interface CommentReplyCollectionData { items?: Word.Interfaces.CommentReplyData[]; } - /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ - interface XmlMappingUpdateData { + /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ + interface XmlMappingData { /** * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * @@ -123056,7 +134843,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + customXmlNode?: Word.Interfaces.CustomXmlNodeData; /** * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * @@ -123064,22 +134851,84 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; + customXmlPart?: Word.Interfaces.CustomXmlPartData; + /** + * 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 + */ + isMapped?: boolean; + /** + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + prefixMappings?: string; + /** + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xpath?: string; } - /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ - interface CustomXmlPrefixMappingCollectionUpdateData { + /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ + interface CustomXmlPrefixMappingCollectionData { items?: Word.Interfaces.CustomXmlPrefixMappingData[]; } - /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ - interface CustomXmlSchemaCollectionUpdateData { + /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ + interface CustomXmlPrefixMappingData { + /** + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + namespaceUri?: string; + /** + * Gets the prefix for the `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + prefix?: string; + } + /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ + interface CustomXmlSchemaData { + /** + * Gets the location of the schema on a computer. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + location?: string; + /** + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + namespaceUri?: string; + } + /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ + interface CustomXmlSchemaCollectionData { items?: Word.Interfaces.CustomXmlSchemaData[]; } - /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ - interface CustomXmlValidationErrorCollectionUpdateData { + /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ + interface CustomXmlValidationErrorCollectionData { items?: Word.Interfaces.CustomXmlValidationErrorData[]; } - /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ - interface CustomXmlValidationErrorUpdateData { + /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ + interface CustomXmlValidationErrorData { /** * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * @@ -123087,14 +134936,62 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - node?: Word.Interfaces.CustomXmlNodeUpdateData; + node?: Word.Interfaces.CustomXmlNodeData; + /** + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + errorCode?: number; + /** + * 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?: string; + /** + * Gets the text in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text?: string; + /** + * Gets the type of error generated from the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; } - /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ - interface CustomXmlNodeCollectionUpdateData { + /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ + interface CustomXmlNodeCollectionData { items?: Word.Interfaces.CustomXmlNodeData[]; } - /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ - interface CustomXmlNodeUpdateData { + /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ + interface CustomXmlNodeData { + /** + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + attributes?: Word.Interfaces.CustomXmlNodeData[]; + /** + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + childNodes?: Word.Interfaces.CustomXmlNodeData[]; /** * 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`. * @@ -123102,7 +134999,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + firstChild?: Word.Interfaces.CustomXmlNodeData; /** * 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`. * @@ -123110,72 +135007,210 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + lastChild?: Word.Interfaces.CustomXmlNodeData; + /** + * 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.CustomXmlNodeData; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ownerPart?: Word.Interfaces.CustomXmlPartData; + /** + * 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.CustomXmlNodeData; + /** + * 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.CustomXmlNodeData; + /** + * Gets the base name of the node without the namespace prefix, if one exists. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + baseName?: string; + /** + * Gets the unique address identifier for the namespace of the node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + namespaceUri?: string; + /** + * Gets the type of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + /** + * 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; + /** + * 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 + */ + xpath?: string; + /** + * Gets the XML representation of the current node and its children. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xml?: string; + } + /** An interface describing the data returned by calling `contentControl.toJSON()`. */ + interface ContentControlData { + /** + * 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.BuildingBlockGalleryContentControlData; + /** + * 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 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * 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.DatePickerContentControlData; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + fields?: Word.Interfaces.FieldData[]; /** - * 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`. + * 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] */ - nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + font?: Word.Interfaces.FontData; /** - * Gets the object representing the part associated with this node. + * 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 */ - ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + groupContentControl?: Word.Interfaces.GroupContentControlData; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * 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] */ - parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * 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`. + * Gets the collection of list objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + lists?: Word.Interfaces.ListData[]; /** - * Specifies the value of the current node. + * 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. */ - nodeValue?: string; + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Specifies the text for the current node. + * 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 */ - text?: string; - } - /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ - interface ContentControlUpdateData { + pictureContentControl?: Word.Interfaces.PictureContentControlData; /** - * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * 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.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Gets the collection of table objects in the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontUpdateData; + tables?: Word.Interfaces.TableData[]; /** * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * @@ -123183,7 +135218,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * @@ -123212,6 +135247,13 @@ declare namespace Word { * [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. * @@ -123240,6 +135282,13 @@ declare namespace Word { * [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. * @@ -123247,6 +135296,13 @@ declare namespace Word { * [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. * @@ -123254,13 +135310,20 @@ declare namespace Word { * [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 for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ - interface ContentControlCollectionUpdateData { + /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ + interface ContentControlCollectionData { items?: Word.Interfaces.ContentControlData[]; } - /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ - interface ContentControlListItemUpdateData { + /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ + interface ContentControlListItemData { /** * Specifies the display text of a list item for a dropdown list or combo box content control. * @@ -123283,12 +135346,26 @@ declare namespace Word { */ value?: string; } - /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ - interface ContentControlListItemCollectionUpdateData { + /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ + interface ContentControlListItemCollectionData { items?: Word.Interfaces.ContentControlListItemData[]; } - /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ - interface CustomPropertyUpdateData { + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ + 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). * @@ -123297,12 +135374,12 @@ declare namespace Word { */ value?: any; } - /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ - interface CustomPropertyCollectionUpdateData { + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ + interface CustomPropertyCollectionData { items?: Word.Interfaces.CustomPropertyData[]; } - /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ - interface CustomXmlPartUpdateData { + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ + interface CustomXmlPartData { /** * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * @@ -123310,32 +135387,184 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; + documentElement?: Word.Interfaces.CustomXmlNodeData; + /** + * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + errors?: Word.Interfaces.CustomXmlValidationErrorData[]; + /** + * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + /** + * 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 + */ + schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + /** + * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * + * @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; + /** + * Gets the namespace URI of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + namespaceUri?: string; + /** + * Gets the XML representation of the current `CustomXmlPart` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xml?: string; } - /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ - interface CustomXmlPartCollectionUpdateData { + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ + interface CustomXmlPartCollectionData { items?: Word.Interfaces.CustomXmlPartData[]; } - /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ - interface CustomXmlPartScopedCollectionUpdateData { + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ + interface CustomXmlPartScopedCollectionData { items?: Word.Interfaces.CustomXmlPartData[]; } - /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ - interface DocumentUpdateData { + /** An interface describing the data returned by calling `document.toJSON()`. */ + interface DocumentData { + /** + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowData; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyData; /** * 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; + 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[]; + /** + * 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 + */ + documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; + /** + * Returns a `FrameCollection` object that represents all the frames in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + frames?: Word.Interfaces.FrameData[]; + /** + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyperlinks?: Word.Interfaces.HyperlinkData[]; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupData; /** * Gets the properties of the document. * * @remarks * [Api set: WordApi 1.3] */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; + 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[]; + /** + * Gets the collection of `Word.Window` objects for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + windows?: Word.Interfaces.WindowData[]; + /** + * 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. * @@ -123343,26 +135572,106 @@ declare namespace Word { * [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({ ... })`. */ - interface DocumentCreatedUpdateData { /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + consecutiveHyphensLimit?: number; /** - * Gets the properties of the document. + * Specifies whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenateCaps?: boolean; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected?: 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; + } + /** 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[]; + /** + * 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] */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; + saved?: boolean; } - /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ - interface DocumentPropertiesUpdateData { + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + 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. * @@ -123391,6 +135700,13 @@ declare namespace Word { * [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. * @@ -123405,6 +135721,27 @@ declare namespace Word { * [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. * @@ -123412,6 +135749,20 @@ declare namespace Word { * [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. * @@ -123420,22 +135771,35 @@ declare namespace Word { */ subject?: string; /** - * Specifies the title of the document. + * Gets the template 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 { + template?: string; /** - * Gets the field's result data. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - result?: Word.Interfaces.RangeUpdateData; + 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 the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeData; /** * Specifies the field's code instruction. * @@ -123451,84 +135815,106 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - data?: string; + 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; + /** + * 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; + /** + * 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()`. */ + interface FieldCollectionData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface describing the data returned by calling `font.toJSON()`. */ + interface FontData { + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + borders?: Word.Interfaces.BorderUniversalData[]; + /** + * 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.FillFormatData; + /** + * 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.GlowFormatData; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line?: Word.Interfaces.LineFormatData; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reflection?: Word.Interfaces.ReflectionFormatData; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textColor?: Word.Interfaces.ColorFormatData; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked?: boolean; + textShadow?: Word.Interfaces.ShadowFormatData; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; /** * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: @@ -123869,12660 +136255,12739 @@ declare namespace Word { * @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 `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ - interface HyperlinkUpdateData { - /** - * 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 - */ - range?: Word.Interfaces.RangeUpdateData; - /** - * Specifies the address (for example, a file name or URL) of the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - address?: string; - /** - * Specifies the text string for the hyperlink's subject line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - emailSubject?: string; - /** - * 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 - */ - screenTip?: string; - /** - * Specifies a named location in the destination of the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - subAddress?: string; - /** - * Specifies the name of the frame or window in which to load the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - target?: string; - /** - * Specifies the hyperlink's visible text in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textToDisplay?: string; - } - /** 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 { - /** - * 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({ ... })`. */ - interface InlinePictureCollectionUpdateData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** 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 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({ ... })`. */ - 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; - /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; - /** - * Specifies the name of the style that's linked to the specified list level object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - linkedStyle?: string; - /** - * Specifies the number format for the specified list level. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - numberFormat?: string; - /** - * Specifies the position (in points) of the number or bullet for the specified list level object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - numberPosition?: number; - /** - * Specifies the number style for the list level object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - 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 list level that must appear before the specified list level restarts numbering at 1. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - resetOnHigher?: number; - /** - * Specifies the starting number for the specified list level object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - startAt?: number; - /** - * Specifies the tab position for the specified list level object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - 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 `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ - interface ListLevelCollectionUpdateData { - items?: Word.Interfaces.ListLevelData[]; - } - /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ - interface ListTemplateUpdateData { - /** - * Specifies whether the specified ListTemplate object is outline numbered. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - outlineNumbered?: boolean; - } - /** 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 `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ - interface NoteItemCollectionUpdateData { - items?: Word.Interfaces.NoteItemData[]; - } - /** 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 `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 { - /** - * 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({ ... })`. */ - interface ParagraphCollectionUpdateData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ - 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; + superscript?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - lineUnitBefore?: number; + 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 whether left and right indents are the same width. + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + underlineColor?: string; + } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + interface HyperlinkData { /** - * Specifies the outline level for the specified paragraphs. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @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"; + range?: Word.Interfaces.RangeData; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + address?: string; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + emailSubject?: string; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + isExtraInfoRequired?: 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. + * Returns the name of the `Hyperlink` object. * * @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 { + name?: string; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; - /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listFormat?: Word.Interfaces.ListFormatUpdateData; + screenTip?: string; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + subAddress?: string; /** - * 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 name of the frame or window in which to load the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + target?: 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. + * Specifies the hyperlink's visible text in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + textToDisplay?: 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. + * Returns the hyperlink type. * * @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"; + type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; } - /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ - interface RangeCollectionUpdateData { - items?: Word.Interfaces.RangeData[]; + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + interface HyperlinkCollectionData { + items?: Word.Interfaces.HyperlinkData[]; } - /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ - interface SearchOptionsUpdateData { + /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ + interface InlinePictureData { /** - * 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 a string that represents the alternative text associated with the inline image. * * @remarks * [Api set: WordApi 1.1] */ - ignorePunct?: boolean; + altTextDescription?: string; /** - * 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 string that contains the title for the inline image. * * @remarks * [Api set: WordApi 1.1] */ - ignoreSpace?: boolean; + altTextTitle?: 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 number that describes the height of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - matchCase?: boolean; + height?: number; /** - * 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 a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks * [Api set: WordApi 1.1] */ - matchPrefix?: boolean; + hyperlink?: 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. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - matchSuffix?: boolean; + imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; /** - * 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 a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks * [Api set: WordApi 1.1] */ - matchWholeWord?: boolean; + lockAspectRatio?: 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. + * Specifies a number that describes the width of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - matchWildcards?: boolean; + width?: number; } - /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ - interface SectionUpdateData { + /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ + interface InlinePictureCollectionData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface describing the data returned by calling `list.toJSON()`. */ + interface ListData { /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * 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.1] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyUpdateData; - } - /** 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 `Setting` object, for use in `setting.set({ ... })`. */ - interface SettingUpdateData { + id?: number; /** - * Specifies the value of the setting. + * 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.4] + * [Api set: WordApi 1.3] */ - value?: any; - } - /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ - interface SettingCollectionUpdateData { - items?: Word.Interfaces.SettingData[]; + 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 for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ - interface StyleCollectionUpdateData { - items?: Word.Interfaces.StyleData[]; + /** An interface describing the data returned by calling `listCollection.toJSON()`. */ + interface ListCollectionData { + items?: Word.Interfaces.ListData[]; } - /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ - interface StyleUpdateData { + /** An interface describing the data returned by calling `listItem.toJSON()`. */ + interface ListItemData { /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies the level of the item in the list. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - borders?: Word.Interfaces.BorderCollectionUpdateData; + level?: number; /** - * Gets a font object that represents the character formatting of the specified style. + * Gets the list item bullet, number, or picture as a string. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontUpdateData; + listString?: string; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Gets the list item order number in relation to its siblings. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + siblingIndex?: number; + } + /** An interface describing the data returned by calling `listLevel.toJSON()`. */ + interface ListLevelData { /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + font?: Word.Interfaces.FontData; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - shading?: Word.Interfaces.ShadingUpdateData; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - tableStyle?: Word.Interfaces.TableStyleUpdateData; + linkedStyle?: string; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApiDesktop 1.1] */ - baseStyle?: string; + numberFormat?: 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. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] + */ + numberPosition?: number; + /** + * Specifies the number style for the list level object. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.1] */ - nextParagraphStyle?: 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"; /** - * Specifies the priority. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - priority?: number; + resetOnHigher?: number; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - quickStyle?: boolean; + startAt?: number; /** - * 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 the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - unhideWhenUsed?: boolean; + tabPosition?: number; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - visibility?: boolean; - } - /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ - interface ShadingUpdateData { + textPosition?: 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 character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - backgroundPatternColor?: string; + 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 { /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Gets a ListLevels collection that represents all the levels for the specified ListTemplate. * * @remarks * [Api set: WordApiDesktop 1.1] */ - foregroundPatternColor?: string; + listLevels?: Word.Interfaces.ListLevelData[]; /** - * 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 whether the specified ListTemplate object is outline numbered. * * @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"; + outlineNumbered?: boolean; } - /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ - interface TableUpdateData { + /** An interface describing the data returned by calling `noteItem.toJSON()`. */ + interface NoteItemData { /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * 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] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontUpdateData; + body?: Word.Interfaces.BodyData; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + reference?: Word.Interfaces.RangeData; /** - * Specifies the number of header rows. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - headerRowCount?: number; + 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 `page.toJSON()`. */ + interface PageData { /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Gets a `BreakCollection` object that represents the breaks on the page. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + breaks?: Word.Interfaces.BreakData[]; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * 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] */ - shadingColor?: string; + height?: number; /** - * 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. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + index?: number; /** - * Specifies whether the table has banded columns. + * 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] */ - styleBandedColumns?: boolean; + 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 { /** - * Specifies whether the table has banded rows. + * Gets the collection of pages in the pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedRows?: boolean; + pages?: Word.Interfaces.PageData[]; /** - * 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 `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: 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"; + 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 { + } + /** 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 whether the table has a first column with a special style. + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies whether the table has a last column with a special style. + * Gets the collection of fields in the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - styleLastColumn?: boolean; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies whether the table has a total (last) row with a special style. + * 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.3] + * [Api set: WordApi 1.1] */ - styleTotalRow?: boolean; + font?: Word.Interfaces.FontData; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - values?: string[][]; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * 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] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + listItem?: Word.Interfaces.ListItemData; /** - * Specifies the width of the table in points. + * 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] */ - width?: number; - } - /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ - interface TableStyleUpdateData { + listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * Specifies the table's alignment against the page margin. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * 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: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - allowBreakAcrossPage?: boolean; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - bottomCellMargin?: number; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the spacing (in points) between the cells in a table style. + * 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.6] + * [Api set: WordApi 1.1] */ - cellSpacing?: number; + firstLineIndent?: number; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - leftCellMargin?: number; + isLastParagraph?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - rightCellMargin?: number; + isListItem?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - topCellMargin?: number; - } - /** 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 `TableRow` object, for use in `tableRow.set({ ... })`. */ - interface TableRowUpdateData { + leftIndent?: number; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * 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.3] + * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontUpdateData; + lineSpacing?: number; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + lineUnitAfter?: number; /** - * Specifies the preferred height of the row in points. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - preferredHeight?: number; + lineUnitBefore?: number; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - shadingColor?: string; + outlineLevel?: number; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - values?: string[][]; + rightIndent?: number; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - 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 { + spaceAfter?: number; /** - * Gets the body object of the cell. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - body?: Word.Interfaces.BodyUpdateData; + spaceBefore?: number; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * 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.3] + * [Api set: WordApi 1.1] */ - columnWidth?: number; + style?: string; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + 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 shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * 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] */ - shadingColor?: string; + tableNestingLevel?: number; /** - * Specifies the text of the cell. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - value?: string; + text?: string; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * 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.3] + * [Api set: WordApi 1.6] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + uniqueLocalId?: string; } - /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ - interface TableCellCollectionUpdateData { - items?: Word.Interfaces.TableCellData[]; + /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ + interface ParagraphCollectionData { + items?: Word.Interfaces.ParagraphData[]; } - /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ - interface TableBorderUpdateData { - /** - * Specifies the table border color. - * - * @remarks - * [Api set: WordApi 1.3] - */ - color?: string; + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + interface ParagraphFormatData { /** - * Specifies the type of the table border. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - 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"; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * 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.3] + * [Api set: WordApi 1.5] */ - width?: number; - } - /** 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 `Shape` object, for use in `shape.set({ ... })`. */ - interface ShapeUpdateData { + firstLineIndent?: number; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - body?: Word.Interfaces.BodyUpdateData; + keepTogether?: 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 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.2] + * [Api set: WordApi 1.5] */ - canvas?: Word.Interfaces.CanvasUpdateData; + keepWithNext?: boolean; /** - * Returns the fill formatting of the shape. + * Specifies the left indent. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - fill?: Word.Interfaces.ShapeFillUpdateData; + leftIndent?: 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 the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - parentCanvas?: Word.Interfaces.ShapeUpdateData; + lineSpacing?: number; /** - * 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 amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - parentGroup?: Word.Interfaces.ShapeUpdateData; + lineUnitAfter?: 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 amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + lineUnitBefore?: number; /** - * Gets the text frame object of the shape. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - textFrame?: Word.Interfaces.TextFrameUpdateData; + mirrorIndents?: boolean; /** - * Returns the text wrap formatting of the shape. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Specifies whether a given shape can overlap other shapes. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - allowOverlap?: boolean; + rightIndent?: number; /** - * Specifies a string that represents the alternative text associated with the shape. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - altTextDescription?: string; + spaceAfter?: number; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - 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"; + spaceBefore?: number; /** - * The height, in points, of the shape. + * 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.2] + * [Api set: WordApi 1.5] */ - height?: number; + widowControl?: boolean; + } + /** An interface describing the data returned by calling `range.toJSON()`. */ + interface RangeData { /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * 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. + * Gets the collection of field objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - left?: number; + fields?: Word.Interfaces.FieldData[]; /** - * 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 the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - leftRelative?: number; + font?: Word.Interfaces.FontData; /** - * Specifies if the aspect ratio of this shape is locked. + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + frames?: Word.Interfaces.FrameData[]; /** - * The name of the shape. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets the collection of inline picture objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.2] */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + listFormat?: Word.Interfaces.ListFormatData; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Gets the collection of pages in the range. * * @remarks * [Api set: WordApiDesktop 1.2] */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + pages?: Word.Interfaces.PageData[]; /** - * 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 collection of sections in the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + sections?: Word.Interfaces.SectionData[]; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + shading?: Word.Interfaces.ShadingUniversalData; /** - * 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 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] */ - top?: number; + shapes?: Word.Interfaces.ShapeData[]; /** - * 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 a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + tableColumns?: Word.Interfaces.TableColumnData[]; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + hasNoProofing?: boolean; /** - * The width, in points, of the shape. + * 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; + hyperlink?: string; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - widthRelative?: number; - } - /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ - interface ShapeGroupUpdateData { + isEmpty?: boolean; /** - * Gets the Shape object associated with the group. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @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 { + languageDetected?: boolean; /** - * Gets the Shape object associated with the canvas. + * Specifies a `LanguageId` value that represents the language for the range. * * @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 { + 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 shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies an East Asian language for the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + 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 shape fill foreground color. 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: 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 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 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - transparency?: number; - } - /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ - interface TextFrameUpdateData { + style?: string; /** - * 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 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + 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"; /** - * Represents the bottom margin, in points, of the text frame. + * Gets the text of the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - bottomMargin?: number; + text?: string; + } + /** 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 { /** - * Represents the left margin, in points, of the text frame. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - leftMargin?: number; + ignorePunct?: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - noTextRotation?: boolean; + ignoreSpace?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + matchCase?: boolean; /** - * Represents the right margin, in points, of the text frame. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - rightMargin?: number; + matchPrefix?: boolean; /** - * Represents the top margin, in points, of the text frame. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - topMargin?: number; + matchSuffix?: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + matchWholeWord?: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - wordWrap?: boolean; + matchWildcards?: boolean; } - /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ - interface ShapeTextWrapUpdateData { + /** An interface describing the data returned by calling `section.toJSON()`. */ + interface SectionData { /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - bottomDistance?: number; + body?: Word.Interfaces.BodyData; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Returns a `PageSetup` object that's associated with the section. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + pageSetup?: Word.Interfaces.PageSetupData; /** - * 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 if the section is protected for forms. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + 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 { /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Gets the key of the setting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - topDistance?: number; + key?: string; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + value?: any; } - /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ - interface ListFormatUpdateData { - /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + /** 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 { /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * 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] */ - listLevelNumber?: number; - } - /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ - interface FillFormatUpdateData { - /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; - /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + borders?: Word.Interfaces.BorderData[]; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * 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] */ - gradientAngle?: number; + font?: Word.Interfaces.FontData; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + frame?: Word.Interfaces.FrameData; /** - * Specifies whether the fill rotates with the shape. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + linkStyle?: Word.Interfaces.StyleData; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * 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] */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Specifies the horizontal scaling factor for the texture fill. + * 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] */ - textureHorizontalScale?: number; + paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Specifies the horizontal offset of the texture from the origin in points. + * 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] */ - textureOffsetX?: number; + shading?: Word.Interfaces.ShadingData; /** - * Specifies the vertical offset of the texture. + * 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] */ - textureOffsetY?: number; + tableStyle?: Word.Interfaces.TableStyleData; /** - * Specifies whether the texture is tiled. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + automaticallyUpdate?: boolean; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * 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. */ - textureVerticalScale?: number; + baseStyle?: string; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - transparency?: number; - } - /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ - interface GlowFormatUpdateData { - /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - color?: Word.Interfaces.ColorFormatUpdateData; + builtIn?: boolean; /** - * Specifies the length of the radius for a glow effect. + * Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: number; + description?: string; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; - } - /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ - interface LineFormatUpdateData { + hasProofing?: boolean; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; - /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + * 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; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + 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 style of the arrowhead at the beginning of the line. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + 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 width of the arrowhead at the beginning of the line. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + linked?: boolean; /** - * Specifies the dash style for the line. + * Returns the list level for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + listLevelNumber?: number; /** - * Specifies the length of the arrowhead at the end of the line. + * Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + locked?: boolean; /** - * Specifies the style of the arrowhead at the end of the line. + * Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + nameLocal?: string; /** - * Specifies the width of the arrowhead at the end of the line. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + nextParagraphStyle?: string; /** - * Specifies if to draw lines inside a shape. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the priority. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isVisible?: boolean; + priority?: number; /** - * Specifies the pattern applied to the line. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - 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"; + quickStyle?: boolean; /** - * Specifies the line format style. + * Gets the style type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * 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] */ - transparency?: number; + unhideWhenUsed?: boolean; /** - * Specifies the thickness of the line in points. + * 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] */ - weight?: number; + visibility?: boolean; } - /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ - interface ReflectionFormatUpdateData { + /** An interface describing the data returned by calling `shading.toJSON()`. */ + interface ShadingData { /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * 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; + /** + * 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: WordApiDesktop 1.1] + */ + foregroundPatternColor?: 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}. + * + * @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"; + } + /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ + interface ShadingUniversalData { + /** + * 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 */ - blur?: number; + backgroundPatternColor?: string; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: 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 size of the reflection as a percentage of the reflected shape from 0 to 100. + * 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 */ - size?: number; + foregroundPatternColor?: string; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * 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 */ - transparency?: 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 a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * 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 */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + 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 `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ - interface ColorFormatUpdateData { + /** An interface describing the data returned by calling `table.toJSON()`. */ + interface TableData { /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets the collection of field objects in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - brightness?: number; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the theme color for a color format. + * 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] */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + font?: Word.Interfaces.FontData; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Gets all of the table rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - rgb?: string; + rows?: Word.Interfaces.TableRowData[]; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets the child tables nested one level deeper. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - tintAndShade?: number; - } - /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ - interface ShadowFormatUpdateData { + tables?: Word.Interfaces.TableData[]; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + * 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 blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - blur?: number; + headerRowCount?: number; /** - * Specifies whether the object or the formatting applied to it is visible. + * 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] */ - isVisible?: boolean; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * 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. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - obscured?: boolean; + isUniform?: 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. + * 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] */ - offsetX?: number; + nestingLevel?: number; /** - * 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 number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - offsetY?: number; + rowCount?: number; /** - * Specifies whether to rotate the shadow when rotating the shape. + * 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] */ - rotateWithShape?: boolean; + shadingColor?: string; /** - * Specifies the width of the shadow. + * 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] */ - size?: number; + style?: string; /** - * Specifies the type of shadow formatting to apply to a shape. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + styleBandedColumns?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - transparency?: number; + styleBandedRows?: boolean; /** - * Specifies the shape shadow type. + * 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] */ - 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 { + 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"; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - contourColor?: Word.Interfaces.ColorFormatUpdateData; + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleFirstColumn?: boolean; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleLastColumn?: boolean; /** - * Specifies the depth of the bottom bevel. + * 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] */ - bevelBottomDepth?: number; + styleTotalRow?: boolean; /** - * Specifies the inset size for the bottom bevel. + * 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] */ - bevelBottomInset?: number; + values?: string[][]; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * 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] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the depth of the top bevel. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bevelTopDepth?: number; + width?: number; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + interface TableStyleData { /** - * Specifies the inset size for the top bevel. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelTopInset?: number; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * 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] */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + allowBreakAcrossPage?: boolean; /** - * Specifies the width of the contour of a shape. + * 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] */ - contourWidth?: number; + bottomCellMargin?: number; /** - * Specifies the depth of the shape's extrusion. + * 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] */ - depth?: number; + cellSpacing?: 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. + * 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] */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + leftCellMargin?: number; /** - * Specifies the amount of perspective for a shape. + * 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] */ - fieldOfView?: number; + rightCellMargin?: number; /** - * 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 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] */ - isPerspective?: boolean; + topCellMargin?: number; + } + /** 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 if the specified object, or the formatting applied to it, is visible. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + borders?: Word.Interfaces.BorderUniversalData[]; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalData; + /** + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + columnIndex?: number; /** - * Specifies the angle of the lighting. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + isFirst?: boolean; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Returns `true` if the column or row is the last one in the table; `false` 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"; + isLast?: boolean; /** - * Specifies the position of the light source relative to the extrusion. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + nestingLevel?: number; /** - * Specifies the intensity of the extrusion lighting. + * 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 */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + preferredWidth?: number; /** - * Specifies the extrusion surface material. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @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"; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + 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 `tableRow.toJSON()`. */ + interface TableRowData { /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - rotationX?: number; + cellCount?: number; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * 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] */ - rotationY?: number; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the z-axis rotation of the camera. + * 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] */ - rotationZ?: number; + isHeader?: boolean; /** - * Specifies the position on the z-axis for the shape. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - z?: number; - } - /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ - interface CritiqueAnnotationData { + preferredHeight?: number; /** - * Gets the critique that was passed when the annotation was inserted. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - critique?: Word.Critique; - } - /** An interface describing the data returned by calling `annotation.toJSON()`. */ - interface AnnotationData { + rowIndex?: number; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - id?: string; + shadingColor?: string; /** - * Gets the state of the annotation. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - 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 `body.toJSON()`. */ - interface BodyData { + values?: string[][]; /** - * Gets the collection of rich text content control objects in the body. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - contentControls?: Word.Interfaces.ContentControlData[]; + 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 collection of field objects in the body. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - fields?: Word.Interfaces.FieldData[]; + body?: Word.Interfaces.BodyData; /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontData; + cellIndex?: number; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + columnWidth?: number; /** - * Gets the collection of list objects in the body. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks * [Api set: WordApi 1.3] */ - lists?: Word.Interfaces.ListData[]; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the collection of paragraph objects in the body. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApi 1.1] + * [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. * - * 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. + * @remarks + * [Api set: WordApi 1.3] */ - paragraphs?: Word.Interfaces.ParagraphData[]; + shadingColor?: string; /** - * 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 the text of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - shapes?: Word.Interfaces.ShapeData[]; + value?: string; /** - * Gets the collection of table objects in the body. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks * [Api set: WordApi 1.3] */ - tables?: Word.Interfaces.TableData[]; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * 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 width of the cell in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: 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 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 table border color. * * @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"; + color?: string; /** - * Gets the text of the body. Use the insertText method to insert text. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - text?: string; + 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 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 the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks * [Api set: WordApi 1.3] */ - type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; + width?: number; } - /** An interface describing the data returned by calling `border.toJSON()`. */ - interface BorderData { + /** An interface describing the data returned by calling `template.toJSON()`. */ + interface TemplateData { /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the location of the border. + * Specifies the line break control level for the document. * * @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"; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies the border type for the border. + * Returns the name of the template, including the drive or Web path. * * @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"; + fullName?: string; /** - * Specifies whether the border is visible. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + hasNoProofing?: boolean; /** - * Specifies the width for the border. + * Specifies the character spacing adjustment for the template. * * @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 `borderCollection.toJSON()`. */ - interface BorderCollectionData { - items?: Word.Interfaces.BorderData[]; - } - /** An interface describing the data returned by calling `break.toJSON()`. */ - interface BreakData { + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + kerningByAlgorithm?: boolean; /** - * Returns the page number on which the break occurs. + * Specifies a `LanguageId` value that represents the language in the template. * * @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 `checkboxContentControl.toJSON()`. */ - interface CheckboxContentControlData { + 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 current state of the checkbox. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; - } - /** An interface describing the data returned by calling `comment.toJSON()`. */ - interface CommentData { + 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 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. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: string; + name?: string; /** - * Gets the name of the comment's author. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: string; + noLineBreakAfter?: string; /** - * Specifies the comment's content as plain text. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + noLineBreakBefore?: string; /** - * Gets the creation date of the comment. + * Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + path?: string; /** - * Gets the ID of the comment. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + saved?: 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. + * Returns the template type. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; + type?: Word.TemplateType | "Normal" | "Global" | "Attached"; } - /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ - interface CommentCollectionData { - items?: Word.Interfaces.CommentData[]; + /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ + interface TemplateCollectionData { + items?: Word.Interfaces.TemplateData[]; } - /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ - interface CommentContentRangeData { + /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ + interface TrackedChangeData { /** - * Specifies a value that indicates whether the comment text is bold. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - bold?: boolean; + author?: string; /** - * 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 date of the tracked change. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - hyperlink?: string; + date?: Date; /** - * Checks whether the range length is zero. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - isEmpty?: boolean; + text?: string; /** - * Specifies a value that indicates whether the comment text is italicized. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - italic?: 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 `shape.toJSON()`. */ + interface ShapeData { /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - strikeThrough?: boolean; + body?: Word.Interfaces.BodyData; /** - * Gets the text of the comment range. + * 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.4] + * [Api set: WordApiDesktop 1.2] */ - text?: string; + canvas?: Word.Interfaces.CanvasData; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - 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 { + fill?: Word.Interfaces.ShapeFillData; /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeData; + * 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: WordApiDesktop 1.2] + */ + parentCanvas?: Word.Interfaces.ShapeData; /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentComment?: Word.Interfaces.CommentData; + * 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: WordApiDesktop 1.2] + */ + parentGroup?: Word.Interfaces.ShapeData; /** - * Gets the email of the comment reply's author. + * 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 1.4] + * [Api set: WordApiDesktop 1.2] */ - authorEmail?: string; + shapeGroup?: Word.Interfaces.ShapeGroupData; /** - * Gets the name of the comment reply's author. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - authorName?: string; + textFrame?: Word.Interfaces.TextFrameData; /** - * Specifies the comment reply's content. The string is plain text. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - content?: string; + textWrap?: Word.Interfaces.ShapeTextWrapData; /** - * Gets the creation date of the comment reply. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - creationDate?: Date; + allowOverlap?: boolean; /** - * Gets the ID of the comment reply. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - 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 `xmlMapping.toJSON()`. */ - interface XmlMappingData { + altTextDescription?: string; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * 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] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeData; + 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"; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - customXmlPart?: Word.Interfaces.CustomXmlPartData; + height?: number; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * 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 + * [Api set: WordApiDesktop 1.2] */ - isMapped?: boolean; + heightRelative?: number; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - prefixMappings?: string; + id?: number; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * 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] */ - 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 { + isChild?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * 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] */ - namespaceUri?: string; + left?: number; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * 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 + * [Api set: WordApiDesktop 1.2] */ - prefix?: string; - } - /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ - interface CustomXmlSchemaData { + leftRelative?: number; /** - * Gets the location of the schema on a computer. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - location?: string; + lockAspectRatio?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * The name of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - 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 { + name?: string; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * 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] */ - node?: Word.Interfaces.CustomXmlNodeData; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * 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] */ - errorCode?: number; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * 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] */ - name?: string; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the text in the `CustomXmlValidationError` object. + * 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] */ - text?: string; + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * 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] */ - 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 { + rotation?: number; /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * 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] */ - attributes?: Word.Interfaces.CustomXmlNodeData[]; + top?: number; /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * 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] */ - childNodes?: Word.Interfaces.CustomXmlNodeData[]; + topRelative?: 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`. + * 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] */ - firstChild?: Word.Interfaces.CustomXmlNodeData; + type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * 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 if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lastChild?: Word.Interfaces.CustomXmlNodeData; + visible?: 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`. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - nextSibling?: Word.Interfaces.CustomXmlNodeData; + width?: number; /** - * Gets the object representing the part associated with this node. + * 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] */ - ownerPart?: Word.Interfaces.CustomXmlPartData; + widthRelative?: number; + } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + interface ShapeGroupData { /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - parentNode?: Word.Interfaces.CustomXmlNodeData; + shape?: Word.Interfaces.ShapeData; /** - * 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`. + * 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] */ - previousSibling?: Word.Interfaces.CustomXmlNodeData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - baseName?: string; + id?: number; + } + /** An interface describing the data returned by calling `canvas.toJSON()`. */ + interface CanvasData { /** - * Gets the unique address identifier for the namespace of the node. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - namespaceUri?: string; + shape?: Word.Interfaces.ShapeData; /** - * Gets the type of the current node. + * 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] */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the value of the current node. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - nodeValue?: string; + 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 text for the current node. + * 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] */ - text?: string; + backgroundColor?: string; /** - * 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. + * 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] */ - xpath?: string; + foregroundColor?: string; /** - * Gets the XML representation of the current node and its children. + * 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] */ - xml?: string; + transparency?: number; + /** + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; } - /** An interface describing the data returned by calling `contentControl.toJSON()`. */ - interface ContentControlData { + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + interface TextFrameData { /** - * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * 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 1.7] + * [Api set: WordApiDesktop 1.2] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Gets the data of the content control when its type is 'ComboBox'. It's `null` otherwise. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.2] */ - comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; + bottomMargin?: number; /** - * Gets the collection of content control objects in the content control. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - contentControls?: Word.Interfaces.ContentControlData[]; + hasText?: boolean; /** - * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.2] */ - dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; + leftMargin?: number; /** - * Gets the collection of field objects in the content control. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - fields?: Word.Interfaces.FieldData[]; + noTextRotation?: boolean; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontData; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + rightMargin?: number; /** - * Gets the collection of list objects in the content control. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - lists?: Word.Interfaces.ListData[]; + topMargin?: number; /** - * Gets the collection of paragraph objects in the content control. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @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: WordApiDesktop 1.2] */ - paragraphs?: Word.Interfaces.ParagraphData[]; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Gets the collection of table objects in the content control. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - tables?: Word.Interfaces.TableData[]; + wordWrap?: boolean; + } + /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ + interface ShapeTextWrapData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * 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] */ - xmlMapping?: Word.Interfaces.XmlMappingData; + bottomDistance?: number; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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 1.1] + * [Api set: WordApiDesktop 1.2] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + leftDistance?: number; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - cannotDelete?: boolean; + rightDistance?: number; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - cannotEdit?: boolean; + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - color?: string; + topDistance?: number; /** - * Gets an integer that represents the content control identifier. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - id?: number; + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + } + /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ + interface RepeatingSectionItemData { /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ + interface DatePickerContentControlData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockData; + /** + * 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.RangeData; + /** + * 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.XmlMappingData; + /** + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: string; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * 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 */ - removeWhenEdited?: boolean; + color?: 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 a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * 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 format in which dates are displayed. * * @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"; + dateDisplayFormat?: 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 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 */ - subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText"; + 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 a tag to identify a content control. + * 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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: string; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Gets the text of the content control. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + id?: string; /** - * Specifies the title for a content control. + * 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 */ - title?: string; + isTemporary?: boolean; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * 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.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"; - } - /** 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 { + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * 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.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + lockContentControl?: boolean; /** - * Specifies the index location of a content control list item in the collection of list items. + * 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.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + lockContents?: boolean; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Gets whether the placeholder text for the content control is being displayed. * * @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 { + showingPlaceholderText?: boolean; /** - * Gets the key of the custom property. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + tag?: string; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + title?: string; + } + /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ + interface PictureContentControlData { /** - * 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). + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockData; + /** + * 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.RangeData; + /** + * 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.XmlMappingData; + /** + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * 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 */ - documentElement?: Word.Interfaces.CustomXmlNodeData; + color?: string; /** - * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - errors?: Word.Interfaces.CustomXmlValidationErrorData[]; + id?: string; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` 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 BETA (PREVIEW ONLY)] * @beta */ - namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + isTemporary?: boolean; /** - * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * 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 */ - schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * 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 */ - builtIn?: boolean; + lockContentControl?: boolean; /** - * Gets the ID of the custom XML part. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + lockContents?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: string; + showingPlaceholderText?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies a tag to identify the content control. * * @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[]; - } - /** 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 { + tag?: string; /** - * Gets the active window for the document. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowData; + title?: string; + } + /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ + interface GroupContentControlData { /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockData; + /** + * 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.RangeData; + /** + * 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.XmlMappingData; + /** + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * 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 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 */ - contentControls?: Word.Interfaces.ContentControlData[]; + color?: string; /** - * Gets the custom XML parts in the document. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + id?: string; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * 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 */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + isTemporary?: boolean; /** - * Gets the properties of the document. + * 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.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesData; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets the collection of section objects in the document. + * 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 */ - sections?: Word.Interfaces.SectionData[]; + lockContentControl?: boolean; /** - * Gets the add-in's settings in the document. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - settings?: Word.Interfaces.SettingData[]; + lockContents?: boolean; /** - * Gets the collection of `Word.Window` objects for the document. + * 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 */ - windows?: Word.Interfaces.WindowData[]; + showingPlaceholderText?: boolean; /** - * Specifies the ChangeTracking mode. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + tag?: 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. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + title?: string; } - /** 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[]; + /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ + interface BuildingBlockGalleryContentControlData { /** - * Gets the properties of the document. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesData; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets the collection of section objects in the document. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sections?: Word.Interfaces.SectionData[]; + range?: Word.Interfaces.RangeData; /** - * Gets the add-in's settings in the document. + * 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: WordApiHiddenDocument 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - settings?: Word.Interfaces.SettingData[]; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * 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 appearance of the content control. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; - } - /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ - interface DocumentPropertiesData { - /** - * Gets the collection of custom properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - customProperties?: Word.Interfaces.CustomPropertyData[]; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the application name of the document. + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - applicationName?: string; + buildingBlockCategory?: string; /** - * Specifies the author of the document. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: 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"; /** - * Specifies the category of 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - category?: string; + color?: 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 identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comments?: string; + id?: string; /** - * Specifies the company of the document. + * 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 */ - company?: string; + isTemporary?: boolean; /** - * Gets the creation date of the document. + * 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.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the format of the document. + * 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 */ - format?: string; + lockContentControl?: boolean; /** - * Specifies the keywords of the document. + * 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 */ - keywords?: string; + lockContents?: boolean; /** - * Gets the last author of the document. + * Gets if the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastAuthor?: string; + showingPlaceholderText?: boolean; /** - * Gets the last print date of the document. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastPrintDate?: Date; + tag?: string; /** - * Gets the last save time of the document. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastSaveTime?: Date; + title?: string; + } + /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ + interface RepeatingSectionContentControlData { /** - * Specifies the manager of the document. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockData; + /** + * 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.RangeData; + /** + * 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.XmlMappingData; + /** + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager?: string; + allowInsertDeleteSection?: boolean; /** - * Gets the revision number of the document. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - revisionNumber?: string; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * 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 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 */ - security?: number; + color?: string; /** - * Specifies the subject of the document. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject?: string; + id?: string; /** - * Gets the template of the document. + * 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 */ - template?: string; + isTemporary?: boolean; /** - * Specifies the title of the document. + * 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.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ - result?: Word.Interfaces.RangeData; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the field's code instruction. + * 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.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - code?: string; + lockContentControl?: 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. + * 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 */ - data?: string; + lockContents?: boolean; /** - * Gets the field's kind. + * 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.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + repeatingSectionItemTitle?: string; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - showCodes?: boolean; + tag?: string; /** - * Gets the field's type. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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[]; + title?: string; } - /** An interface describing the data returned by calling `font.toJSON()`. */ - interface FontData { - /** - * 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.FillFormatData; + /** An interface describing the data returned by calling `frame.toJSON()`. */ + interface FrameData { /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatData; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatData; + range?: Word.Interfaces.RangeData; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatData; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textColor?: Word.Interfaces.ColorFormatData; + * Specifies the height (in points) of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + height?: number; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textShadow?: Word.Interfaces.ShadowFormatData; + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * 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.ThreeDimensionalFormatData; + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalDistanceFromText?: number; /** - * 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. + * 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 */ - allCaps?: boolean; + horizontalPosition?: number; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies if the frame is locked. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + lockAnchor?: 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. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the relative vertical position of the frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies if document text wraps around the frame. * * @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"; + textWrap?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @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"; + verticalDistanceFromText?: number; /** - * Specifies whether contextual alternates are enabled for the font. + * 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 */ - contextualAlternates?: boolean; + verticalPosition?: number; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the width (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + width?: number; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies the rule used to determine the width of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + 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 value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Gets any optional comments associated with this version of the shared document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleStrikeThrough?: boolean; + comments?: string; /** - * 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. + * 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 */ - emboss?: boolean; + modified?: any; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * 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 */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + 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 `listFormat.toJSON()`. */ + interface ListFormatData { /** - * 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. + * 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.ListData; + /** + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listTemplate?: Word.Interfaces.ListTemplateData; + /** + * Indicates whether the `ListFormat` object contains a single list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave?: boolean; + isSingleList?: boolean; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden?: boolean; + isSingleListTemplate?: 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 the list level number for the first paragraph for the `ListFormat` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlightColor?: string; + listLevelNumber?: number; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + listString?: string; /** - * 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. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + listValue?: number; + } + /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ + interface FillFormatData { /** - * Specifies the ligature setting for the `Font` object. + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + backgroundColor?: Word.Interfaces.ColorFormatData; + /** + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + foregroundColor?: Word.Interfaces.ColorFormatData; + /** + * 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 */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + gradientAngle?: number; /** - * Specifies a value that represents the name of the font. + * Gets the gradient color type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * 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 */ - nameAscii?: string; + gradientDegree?: number; /** - * Specifies the font name in a right-to-left language document. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameBidirectional?: string; + gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Specifies the East Asian font name. + * 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 */ - nameFarEast?: string; + gradientVariant?: number; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + isVisible?: boolean; /** - * Specifies the number form setting for an OpenType font. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + 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 spacing setting for the font. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + 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 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. + * Gets the preset texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline?: boolean; + 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 position of text (in points) relative to the base line. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; + rotateWithObject?: boolean; /** - * Specifies the scaling percentage applied to the font. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling?: number; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * 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 the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadow?: boolean; + textureHorizontalScale?: number; /** - * Specifies a value that represents the font size in points. + * Returns the name of the custom texture file for the fill. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - size?: number; + textureName?: string; /** - * Specifies the font size in points for right-to-left text. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional?: number; + textureOffsetX?: 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 vertical offset of the texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + textureOffsetY?: number; /** - * Specifies the spacing between characters. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + textureTile?: boolean; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Returns the texture type for the fill. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Specifies the stylistic set for the font. + * 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 */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + textureVerticalScale?: number; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * 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 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subscript?: boolean; + transparency?: number; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Gets the fill format type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - superscript?: boolean; + type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + } + /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ + interface GlowFormatData { /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: Word.Interfaces.ColorFormatData; + /** + * Specifies the length of the radius for a glow effect. * * @remarks - * [Api set: WordApi 1.1] + * [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"; + radius?: number; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * 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 */ - underlineColor?: string; + transparency?: number; } - /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ - interface HyperlinkData { + /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ + interface LineFormatData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + backgroundColor?: Word.Interfaces.ColorFormatData; + /** + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + foregroundColor?: Word.Interfaces.ColorFormatData; + /** + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: string; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: string; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtraInfoRequired?: boolean; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Returns the name of the `Hyperlink` object. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: string; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: string; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + weight?: number; + } + /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ + interface ReflectionFormatData { + /** + * 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 */ - target?: string; + blur?: number; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textToDisplay?: string; + offset?: number; /** - * Returns the hyperlink type. + * 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 */ - 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 { + size?: number; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + transparency?: number; /** - * Specifies a string that contains the title for the inline image. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: string; + 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 a number that describes the height of the inline image. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + brightness?: number; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies the theme color for a color format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Gets the format of the inline image. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + rgb?: string; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * 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 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + tintAndShade?: number; /** - * Specifies a number that describes the width of the inline image. + * Returns the shape color type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ - interface InlinePictureCollectionData { - items?: Word.Interfaces.InlinePictureData[]; + type?: Word.ColorType | "rgb" | "scheme"; } - /** An interface describing the data returned by calling `list.toJSON()`. */ - interface ListData { + /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ + interface ShadowFormatData { /** - * Gets paragraphs in the list. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphs?: Word.Interfaces.ParagraphData[]; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Gets the list's id. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + blur?: 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 whether the object or the formatting applied to it is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean[]; + isVisible?: boolean; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + obscured?: boolean; /** - * Specifies the level of the item in the list. + * 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: number; + offsetX?: number; /** - * Gets the list item bullet, number, or picture as a 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listString?: string; + offsetY?: number; /** - * Gets the list item order number in relation to its siblings. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - siblingIndex?: number; - } - /** An interface describing the data returned by calling `listLevel.toJSON()`. */ - interface ListLevelData { + rotateWithShape?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies the width of the shadow. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + size?: number; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: string; + transparency?: number; /** - * Specifies the number format for the specified list level. + * Specifies the shape shadow type. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + 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 position (in points) of the number or bullet for the specified list level object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - numberPosition?: number; + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contourColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the number style for the list level object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - 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"; + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + extrusionColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the depth of the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: number; + bevelBottomDepth?: number; /** - * Specifies the starting number for the specified list level object. + * Specifies the inset size for the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + bevelBottomInset?: number; /** - * Specifies the tab position for the specified list level object. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the depth of the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: number; + bevelTopDepth?: number; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the inset size for the top bevel. * * @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 { + bevelTopInset?: number; /** - * Gets a ListLevels collection that represents all the levels for the specified ListTemplate. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listLevels?: Word.Interfaces.ListLevelData[]; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Specifies whether the specified ListTemplate object is outline numbered. + * Specifies the width of the contour of a shape. * * @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 { + contourWidth?: number; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Specifies the depth of the shape's extrusion. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + depth?: number; /** - * Represents a footnote or endnote reference in the main document. + * 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 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeData; + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Represents the note item type: footnote or endnote. + * Specifies the amount of perspective for a shape. * * @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 `page.toJSON()`. */ - interface PageData { + fieldOfView?: number; /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * 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 */ - breaks?: Word.Interfaces.BreakData[]; + isPerspective?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * 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 */ - height?: number; + isVisible?: boolean; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the angle of the lighting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + lightAngle?: number; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + 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 collection of pages in the pane. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pages?: Word.Interfaces.PageData[]; + presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { - } - /** 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 { + 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 collection of fields in the paragraph. + * Specifies the position of the light source relative to the extrusion. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Specifies the intensity of the extrusion lighting. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * Specifies the extrusion surface material. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Returns the preset extrusion format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItem?: Word.Interfaces.ListItemData; + 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 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 whether text on a shape rotates with shape. `true` rotates the text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemData; + projectText?: 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 rotation of the extruded shape around the x-axis in degrees. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + rotationX?: number; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + rotationY?: number; /** - * 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 z-axis rotation of the camera. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + rotationZ?: number; /** - * Indicates the paragraph is the last one inside its parent body. + * Specifies the position on the z-axis for the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + z?: number; + } + /** An interface describing the data returned by calling `bibliography.toJSON()`. */ + interface BibliographyData { /** - * Checks whether the paragraph is a list item. - * - * @remarks - * [Api set: WordApi 1.3] - */ - isListItem?: boolean; + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sources?: Word.Interfaces.SourceData[]; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies the name of the active style to use for the bibliography. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + 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 { /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Gets if the `Source` object has been cited in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + isCited?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Gets the tag of the source. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + tag?: string; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Gets the XML representation of the source. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + xml?: string; + } + /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ + interface PageSetupData { /** - * Specifies the outline level for the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] - */ - outlineLevel?: number; + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Specifies the right indent value, in points, for the paragraph. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textColumns?: Word.Interfaces.TextColumnData[]; + /** + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + bookFoldPrinting?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies the number of pages for each booklet. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + bookFoldPrintingSheets?: number; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + bookFoldReversePrinting?: 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 the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + bottomMargin?: 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 number of characters per line in the document grid. * * @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"; + charsLine?: number; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Specifies whether the first page has a different header and footer. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableNestingLevel?: number; + differentFirstPageHeaderFooter?: boolean; /** - * Gets the text of the paragraph. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + footerDistance?: number; /** - * 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 the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks - * [Api set: WordApi 1.6] - */ - 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 { + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gutter?: number; /** - * Specifies the alignment for the specified paragraphs. + * Specifies on which side the gutter appears in a document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * 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 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 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies the distance between the header and the top of the page in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + headerDistance?: number; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies the layout mode for the current document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies the left indent. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + leftMargin?: number; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies the number of lines per page in the document grid. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + linesPage?: number; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + mirrorMargins?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies whether odd and even pages have different headers and footers. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies whether left and right indents are the same width. + * Specifies the orientation of the page. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Specifies the outline level for the specified paragraphs. + * Specifies the page height in points. * * @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"; + pageHeight?: number; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the page width in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + pageWidth?: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the paper size of the page. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + 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 the spacing (in points) before the specified paragraphs. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + rightMargin?: 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. + * Specifies the reading order and alignment for the specified sections. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl?: boolean; - } - /** An interface describing the data returned by calling `range.toJSON()`. */ - interface RangeData { + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Gets the collection of field objects in the range. + * Specifies the type of section break for the specified object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies whether to show the grid. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + showGrid?: boolean; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * 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 */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + suppressEndnotes?: boolean; /** - * Gets the collection of inline picture objects in the range. + * Specifies the top margin of the page in points. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + topMargin?: number; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listFormat?: Word.Interfaces.ListFormatData; + twoPagesOnOne?: boolean; /** - * Gets the collection of pages in the range. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pages?: Word.Interfaces.PageData[]; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ + interface LineNumberingData { /** - * 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 numeric increment for line numbers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + countBy?: number; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * 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 */ - hasNoProofing?: boolean; + distanceFromText?: 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 if line numbering is active for the specified document, section, or sections. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + isActive?: boolean; /** - * Checks whether the range length is zero. + * 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * 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 starting line number. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: 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 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 amount of spacing (in points) after the specified paragraph or text column. * * @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"; + spaceAfter?: number; /** - * Gets the text of the range. + * Specifies the width, in points, of the specified text columns. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; - } - /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ - interface RangeCollectionData { - items?: Word.Interfaces.RangeData[]; + width?: number; } - /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ - interface SearchOptionsData { + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CritiqueAnnotationLoadOptions { /** - * 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. + 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.1] + * [Api set: WordApi 1.7] */ - ignorePunct?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * 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. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.7] */ - ignoreSpace?: boolean; + critique?: boolean; + } + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationLoadOptions { /** - * 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. + 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.1] + * [Api set: WordApi 1.7] */ - matchCase?: boolean; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * 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. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.7] */ - matchPrefix?: boolean; + id?: 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. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.7] */ - matchSuffix?: boolean; + state?: boolean; + } + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationCollectionLoadOptions { /** - * 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. + 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.1] + * [Api set: WordApi 1.7] */ - matchWholeWord?: boolean; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * 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. + * 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.1] + * [Api set: WordApi 1.7] */ - matchWildcards?: boolean; - } - /** An interface describing the data returned by calling `section.toJSON()`. */ - interface SectionData { + id?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * For EACH ITEM in the collection: Gets the state of the annotation. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.7] */ - body?: Word.Interfaces.BodyData; - } - /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ - interface SectionCollectionData { - items?: Word.Interfaces.SectionData[]; + state?: boolean; } - /** An interface describing the data returned by calling `setting.toJSON()`. */ - interface SettingData { + /** + * Represents the application object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ApplicationLoadOptions { /** - * Gets the key of the setting. + 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 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Specifies the value of the setting. + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @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 { + checkLanguage?: boolean; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderData[]; + language?: boolean; + } + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface BodyLoadOptions { /** - * Gets a font object that represents the character formatting of the specified style. + 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.5] + * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontData; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * 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: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - listTemplate?: Word.Interfaces.ListTemplateData; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * 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.5] + * [Api set: WordApi 1.3] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatData; + parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * 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.6] + * [Api set: WordApi 1.1] */ - shading?: Word.Interfaces.ShadingData; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * 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.6] + * [Api set: WordApi 1.3] */ - tableStyle?: Word.Interfaces.TableStyleData; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi 1.3] */ - baseStyle?: string; + parentSection?: Word.Interfaces.SectionLoadOptions; /** - * Gets whether the specified style is a built-in style. + * 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.5] + * [Api set: WordApi 1.3] */ - builtIn?: boolean; + parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** - * Gets the description of the specified style. + * 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] */ - description?: string; + style?: 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 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.5] + * [Api set: WordApi 1.3] */ - inUse?: boolean; + styleBuiltIn?: boolean; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - linked?: boolean; + text?: boolean; /** - * Gets the name of a style in the language of the user. + * 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.5] + * [Api set: WordApi 1.3] */ - nameLocal?: string; + type?: boolean; + } + /** + * Represents the Border object for text, a paragraph, or a table. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderLoadOptions { /** - * 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. + 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. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] + */ + color?: boolean; + /** + * Gets the location of the border. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.1] */ - nextParagraphStyle?: string; + location?: boolean; /** - * Specifies the priority. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - priority?: number; + type?: boolean; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - quickStyle?: boolean; + visible?: boolean; /** - * Gets the style type. + * Specifies the width for the border. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + 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 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. + 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 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + artStyle?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; - } - /** An interface describing the data returned by calling `shading.toJSON()`. */ - interface ShadingData { + artWidth?: boolean; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundPatternColor?: string; + color?: boolean; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundPatternColor?: string; + colorIndex?: 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}. + * Returns `true` if an inside border can be applied to the specified object. * * @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 describing the data returned by calling `table.toJSON()`. */ - interface TableData { + inside?: boolean; /** - * Gets the collection of field objects in the table. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + isVisible?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies the line style of the border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + lineStyle?: boolean; /** - * Gets all of the table rows. + * Specifies the line width of an object's border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rows?: Word.Interfaces.TableRowData[]; + lineWidth?: boolean; + } + /** + * Represents the collection of border styles. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderCollectionLoadOptions { /** - * Gets the child tables nested one level deeper. + 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - tables?: Word.Interfaces.TableData[]; + color?: boolean; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Gets the location of the border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + location?: boolean; /** - * Specifies the number of header rows. + * For EACH ITEM in the collection: Specifies the border type for the border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - headerRowCount?: number; + type?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + visible?: boolean; /** - * Indicates whether all of the table rows are uniform. + * For EACH ITEM in the collection: Specifies the width for the border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - isUniform?: boolean; + width?: boolean; + } + /** + * Represents the collection of {@link Word.BorderUniversal} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BorderUniversalCollectionLoadOptions { + /** + 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 nesting level of the table. Top-level tables have level 1. + * For EACH ITEM in the collection: Specifies the graphical page-border design for the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nestingLevel?: number; + artStyle?: boolean; /** - * Gets the number of rows in the table. + * 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowCount?: number; + artWidth?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + color?: 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. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + colorIndex?: boolean; /** - * Specifies whether the table has banded columns. + * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + inside?: boolean; /** - * Specifies whether the table has banded rows. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + isVisible?: 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. + * For EACH ITEM in the collection: Specifies the line style of the border. * * @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"; + lineStyle?: boolean; /** - * Specifies whether the table has a first column with a special style. + * For EACH ITEM in the collection: Specifies the line width of an object's border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + lineWidth?: boolean; + } + /** + * Represents a break in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BreakLoadOptions { /** - * Specifies whether the table has a last column with a special style. - * - * @remarks - * [Api set: WordApi 1.3] + 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`). */ - styleLastColumn?: boolean; + $all?: boolean; /** - * Specifies whether the table has a total (last) row with a special style. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Returns the page number on which the break occurs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + pageIndex?: boolean; + } + /** + * Contains a collection of {@link Word.Break} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BreakCollectionLoadOptions { /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the width of the table in points. + * For EACH ITEM in the collection: Returns the page number on which the break occurs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + pageIndex?: boolean; } - /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ - interface TableStyleData { + /** + * 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 { /** - * Specifies the table's alignment against the page margin. - * - * @remarks - * [Api set: WordApiDesktop 1.1] + 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`). */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + $all?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; + /** + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + /** + * Specifies the description for the building block. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + description?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Returns the internal identification number for the building block. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + id?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Returns the position of this building block in a collection. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + index?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + insertType?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Specifies the name of the building block. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: number; + name?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies the contents of the building block. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: number; - } - /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ - interface TableCollectionData { - items?: Word.Interfaces.TableData[]; + value?: boolean; } - /** An interface describing the data returned by calling `tableRow.toJSON()`. */ - interface TableRowData { + /** + * Represents a category of building blocks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockCategoryLoadOptions { /** - * Gets cells. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cells?: Word.Interfaces.TableCellData[]; + 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 collection of field objects in the table row. + * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * 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; + * Returns the position of the `BuildingBlockCategory` object in a collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + index?: boolean; /** - * Gets the number of cells in the row. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellCount?: number; + name?: boolean; + } + /** + * Represents a type of building block in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockTypeItemLoadOptions { /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + index?: boolean; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Returns the localized name of a building block type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isHeader?: boolean; + name?: boolean; + } + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CheckboxContentControlLoadOptions { /** - * Specifies the preferred height of the row in points. + 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.3] + * [Api set: WordApi 1.7] */ - preferredHeight?: number; + isChecked?: boolean; + } + /** + * Represents a comment in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentLoadOptions { /** - * Gets the index of the row in its parent table. + 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.3] + * [Api set: WordApi 1.4] */ - rowIndex?: number; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - shadingColor?: string; + authorEmail?: boolean; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - values?: string[][]; + authorName?: boolean; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - 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 { + content?: boolean; /** - * Gets the body object of the cell. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - body?: Word.Interfaces.BodyData; + creationDate?: boolean; /** - * Gets the index of the cell in its row. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - cellIndex?: number; + id?: boolean; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * 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] */ - columnWidth?: number; + resolved?: boolean; + } + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentCollectionLoadOptions { /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + 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.3] + * [Api set: WordApi 1.4] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Gets the index of the cell's row in the table. + * 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] */ - rowIndex?: number; + authorEmail?: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * For EACH ITEM in the collection: Gets the name of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - shadingColor?: string; + authorName?: boolean; /** - * Specifies the text of the cell. + * 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] */ - value?: string; + content?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Gets the creation date of the comment. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + creationDate?: boolean; /** - * Gets the width of the cell in points. + * For EACH ITEM in the collection: Gets the ID of the comment. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - 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 { + id?: boolean; /** - * Specifies the table border color. + * 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.3] + * [Api set: WordApi 1.4] */ - color?: string; + resolved?: boolean; + } + /** + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentContentRangeLoadOptions { /** - * Specifies the type of the table border. + 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.3] + * [Api set: WordApi 1.4] */ - 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"; + bold?: boolean; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * 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.3] + * [Api set: WordApi 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ - interface TrackedChangeData { + hyperlink?: boolean; /** - * Gets the author of the tracked change. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.4] */ - author?: string; + isEmpty?: boolean; /** - * Gets the date of the tracked change. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.4] */ - date?: Date; + italic?: boolean; /** - * Gets the text of the tracked change. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.4] */ - text?: string; + strikeThrough?: boolean; /** - * Gets the type of the tracked change. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.4] */ - 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 `shape.toJSON()`. */ - interface ShapeData { + text?: boolean; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - body?: Word.Interfaces.BodyData; + underline?: boolean; + } + /** + * Represents a comment reply in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentReplyLoadOptions { /** - * 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}. + 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - canvas?: Word.Interfaces.CanvasData; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Returns the fill formatting of the shape. + * Gets the parent comment of this reply. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - fill?: Word.Interfaces.ShapeFillData; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * 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 email of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - parentCanvas?: Word.Interfaces.ShapeData; + authorEmail?: 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. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - parentGroup?: Word.Interfaces.ShapeData; + authorName?: boolean; /** - * 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 comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - shapeGroup?: Word.Interfaces.ShapeGroupData; + content?: boolean; /** - * Gets the text frame object of the shape. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - textFrame?: Word.Interfaces.TextFrameData; + creationDate?: boolean; /** - * Returns the text wrap formatting of the shape. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - textWrap?: Word.Interfaces.ShapeTextWrapData; + 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 { /** - * Specifies whether a given shape can overlap other shapes. + 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - allowOverlap?: boolean; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies a string that represents the alternative text associated with the shape. + * For EACH ITEM in the collection: Gets the parent comment of this reply. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - altTextDescription?: string; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * For EACH ITEM in the collection: Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - 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"; + authorEmail?: boolean; /** - * The height, in points, of the shape. + * For EACH ITEM in the collection: Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - height?: number; + authorName?: boolean; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - heightRelative?: number; + content?: boolean; /** - * Gets an integer that represents the shape identifier. + * For EACH ITEM in the collection: Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - id?: number; + creationDate?: boolean; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * For EACH ITEM in the collection: Gets the ID of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - isChild?: boolean; + id?: 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 { /** - * 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. + 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 `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * 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. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Specifies if the aspect ratio of this shape is locked. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + isMapped?: boolean; /** - * The name of the shape. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + prefixMappings?: boolean; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + xpath?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlPrefixMappingCollectionLoadOptions { /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + 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 unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + namespaceUri?: boolean; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + prefix?: boolean; + } + /** + * Represents a `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlPrefixMappingLoadOptions { /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + 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 unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + namespaceUri?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + prefix?: boolean; + } + /** + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlSchemaLoadOptions { /** - * 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. + 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 location of the schema on a computer. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + location?: boolean; /** - * 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 unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + 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 { /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + 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 location of the schema on a computer. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + location?: boolean; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + namespaceUri?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlValidationError} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlValidationErrorCollectionLoadOptions { /** - * The width, in points, of the shape. + 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 node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @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 { + errorCode?: boolean; /** - * Gets the Shape object associated with the group. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + name?: boolean; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + text?: boolean; /** - * Gets an integer that represents the shape group identifier. + * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + type?: boolean; } - /** An interface describing the data returned by calling `canvas.toJSON()`. */ - interface CanvasData { + /** + * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlValidationErrorLoadOptions { /** - * Gets the Shape object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + 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`). */ - shape?: Word.Interfaces.ShapeData; + $all?: boolean; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets an integer that represents the canvas identifier. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + errorCode?: boolean; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + name?: boolean; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the text in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + text?: boolean; /** - * 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 type of error generated from the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: number; + type?: boolean; + } + /** + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlNodeCollectionLoadOptions { /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + 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`. * * @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 { + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * 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. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Represents the bottom margin, in points, of the text frame. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies if the text frame contains text. + * For EACH ITEM in the collection: Gets the object representing the part associated with this node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hasText?: boolean; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Represents the left margin, in points, of the text frame. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + baseName?: boolean; /** - * Represents the right margin, in points, of the text frame. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + namespaceUri?: boolean; /** - * Represents the top margin, in points, of the text frame. + * For EACH ITEM in the collection: Gets the type of the current node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + nodeType?: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * For EACH ITEM in the collection: Specifies the value of the current node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + nodeValue?: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * For EACH ITEM in the collection: Specifies the text for the current 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 { + text?: boolean; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + xpath?: boolean; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + xml?: boolean; + } + /** + * 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 CustomXmlNodeLoadOptions { /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + 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`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * 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 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Gets the object representing the part associated with this node. * * @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 describing the data returned by calling `listFormat.toJSON()`. */ - interface ListFormatData { + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` 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 */ - list?: Word.Interfaces.ListData; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the list template associated with the `ListFormat` 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 */ - listTemplate?: Word.Interfaces.ListTemplateData; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Indicates whether the `ListFormat` object contains a single list. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleList?: boolean; + baseName?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleListTemplate?: boolean; + namespaceUri?: boolean; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; + nodeType?: boolean; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listString?: string; + nodeValue?: boolean; /** - * Gets the type of the list for the `ListFormat` object. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + text?: boolean; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * 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 */ - listValue?: number; - } - /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ - interface FillFormatData { - /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - backgroundColor?: Word.Interfaces.ColorFormatData; + xpath?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatData; + * Gets the XML representation of the current node and its children. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface ContentControlLoadOptions { /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + 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. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Gets the gradient color type. + * 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] */ - gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * 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. + * 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 */ - gradientDegree?: number; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Returns the gradient style for the fill. + * 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] */ - gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + font?: Word.Interfaces.FontLoadOptions; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * 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 */ - gradientVariant?: number; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets the parent body of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVisible?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * 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] */ - 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"; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns the preset gradient type for the fill. + * 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] */ - 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"; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the preset texture. + * 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] */ - 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"; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether the fill rotates with the shape. + * 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] */ - rotateWithObject?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * 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] */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the horizontal scaling factor for the texture fill. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textureHorizontalScale?: number; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Returns the name of the custom texture file for the fill. + * 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 */ - textureName?: string; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Specifies the horizontal offset of the texture from the origin in points. + * 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 */ - textureOffsetX?: number; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Specifies the vertical offset of the texture. + * 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 */ - textureOffsetY?: number; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Specifies whether the texture is tiled. + * 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] */ - textureTile?: boolean; + appearance?: boolean; /** - * Returns the texture type for the fill. + * 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] */ - textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + cannotDelete?: boolean; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * 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] */ - textureVerticalScale?: number; + cannotEdit?: boolean; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * 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] */ - transparency?: number; + color?: boolean; /** - * Gets the fill format type. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; - } - /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ - interface GlowFormatData { - /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - color?: Word.Interfaces.ColorFormatData; + id?: boolean; /** - * Specifies the length of the radius for a glow effect. + * 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] */ - radius?: number; + placeholderText?: boolean; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * 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] */ - transparency?: number; - } - /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ - interface LineFormatData { - /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - backgroundColor?: Word.Interfaces.ColorFormatData; - /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatData; + removeWhenEdited?: boolean; /** - * Specifies the length of the arrowhead at the beginning of the line. + * 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] */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + style?: boolean; /** - * Specifies the style of the arrowhead at the beginning of the line. + * 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] */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + styleBuiltIn?: boolean; /** - * Specifies the width of the arrowhead at the beginning of the line. + * 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] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + subtype?: boolean; /** - * Specifies the dash style for the line. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + tag?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + text?: boolean; /** - * Specifies the style of the arrowhead at the end of the line. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + title?: boolean; /** - * Specifies the width of the arrowhead at the end of the line. + * 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] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + 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 { /** - * Specifies if to draw lines inside a shape. + 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 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 */ - insetPen?: boolean; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Specifies if the object, or the formatting applied to it, is visible. + * 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] */ - isVisible?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Specifies the pattern applied to the line. + * 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 */ - 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"; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Specifies the line format style. + * 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] */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * 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 */ - transparency?: number; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Specifies the thickness of the line in points. + * For EACH ITEM in the collection: Gets the parent body of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - weight?: number; - } - /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ - interface ReflectionFormatData { + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * 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] */ - blur?: number; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * 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] */ - offset?: number; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * 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] */ - size?: number; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * 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] */ - transparency?: number; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * 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] */ - 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 { + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - brightness?: number; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the theme color for a color format. + * 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 */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * 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 */ - rgb?: string; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * 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 */ - tintAndShade?: number; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Returns the shape color type. + * 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] */ - type?: Word.ColorType | "rgb" | "scheme"; - } - /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ - interface ShadowFormatData { - /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatData; + appearance?: boolean; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - blur?: number; + cannotDelete?: boolean; /** - * Specifies whether the object or the formatting applied to it is visible. + * 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] */ - isVisible?: boolean; + cannotEdit?: 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. + * 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] */ - obscured?: boolean; + color?: 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. + * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - offsetX?: number; + id?: 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. + * 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] */ - offsetY?: number; + placeholderText?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * 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] */ - rotateWithShape?: boolean; + removeWhenEdited?: boolean; /** - * Specifies the width of the shadow. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - size?: number; + style?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * 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] */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + styleBuiltIn?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * 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] */ - transparency?: number; + subtype?: boolean; /** - * Specifies the shape shadow type. + * 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] */ - 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 { - /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - contourColor?: Word.Interfaces.ColorFormatData; + tag?: boolean; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - extrusionColor?: Word.Interfaces.ColorFormatData; + * For EACH ITEM in the collection: Gets the text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; /** - * Specifies the depth of the bottom bevel. + * 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] */ - bevelBottomDepth?: number; + title?: boolean; /** - * Specifies the inset size for the bottom bevel. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bevelBottomInset?: number; + type?: boolean; + } + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + interface ContentControlListItemLoadOptions { /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + displayText?: boolean; /** - * Specifies the depth of the top bevel. + * 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] */ - bevelTopDepth?: number; + index?: boolean; /** - * Specifies the inset size for the top bevel. + * 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] */ - bevelTopInset?: number; + 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 { /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + 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] */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + displayText?: boolean; /** - * Specifies the width of the contour of a shape. + * 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] */ - contourWidth?: number; + index?: boolean; /** - * Specifies the depth of the shape's extrusion. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] + */ + value?: boolean; + } + /** + * Represents a custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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`). */ - depth?: number; + $all?: boolean; /** - * 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 key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + key?: boolean; /** - * Specifies the amount of perspective for a shape. + * 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] */ - fieldOfView?: number; + type?: 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. + * 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] */ - isPerspective?: boolean; + value?: boolean; + } + /** + * Contains the collection of {@link Word.CustomProperty} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface CustomPropertyCollectionLoadOptions { /** - * Specifies if the specified object, or the formatting applied to it, is visible. - * - * @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`). */ - isVisible?: boolean; + $all?: boolean; /** - * Specifies the angle of the lighting. + * 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] */ - lightAngle?: number; + key?: boolean; /** - * Returns a `PresetCamera` value that represents the camera presets. + * 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] */ - 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"; + type?: boolean; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * 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] */ - presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + value?: boolean; + } + /** + * Represents a custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartLoadOptions { /** - * Specifies a `LightRigType` value that represents the lighting preset. + 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 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 */ - 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"; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the position of the light source relative to the extrusion. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + builtIn?: boolean; /** - * Specifies the intensity of the extrusion lighting. + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + id?: boolean; /** - * Specifies the extrusion surface material. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + namespaceUri?: boolean; /** - * Returns the preset extrusion format. + * Gets the XML representation of the current `CustomXmlPart` object. * * @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"; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartCollectionLoadOptions { /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + 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 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 */ - projectText?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * 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 */ - rotationX?: number; + builtIn?: boolean; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * 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] */ - rotationY?: number; + id?: boolean; /** - * Specifies the z-axis rotation of the camera. + * 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] */ - rotationZ?: number; + namespaceUri?: boolean; /** - * Specifies the position on the z-axis for the shape. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: number; + xml?: boolean; } /** - * Represents an annotation wrapper around critique displayed in the document. + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - interface CritiqueAnnotationLoadOptions { + 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; /** - * Gets the range of text that is annotated. + * 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 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the critique that was passed when the annotation was inserted. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks - * [Api set: WordApi 1.7] - */ - critique?: boolean; - } - /** - * Represents an annotation attached to a paragraph. - * - * @remarks - * [Api set: WordApi 1.7] - */ - 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + builtIn?: boolean; /** - * Gets the critique annotation object. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + id?: 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 namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - id?: boolean; + namespaceUri?: boolean; /** - * Gets the state of the annotation. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - state?: boolean; + xml?: boolean; } /** - * Contains a collection of {@link Word.Annotation} objects. + * 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.7] + * [Api set: WordApi 1.1] */ - interface AnnotationCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets the critique annotation object. + * Specifies a `Template` object that represents the template attached to the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + attachedTemplate?: Word.Interfaces.TemplateLoadOptions; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * For EACH ITEM in the collection: Gets the state of the annotation. + * 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.7] + * [Api set: WordApi 1.1] */ - state?: boolean; - } - /** - * Represents the body of a document or a section. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface BodyLoadOptions { + body?: Word.Interfaces.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`). + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontLoadOptions; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * 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. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + autoHyphenation?: 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}. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; + autoSaveOn?: boolean; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + changeTrackingMode?: 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}. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + consecutiveHyphensLimit?: boolean; /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentSection?: Word.Interfaces.SectionLoadOptions; + hyphenateCaps?: 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 whether Microsoft Word has detected the language of the document text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; + languageDetected?: 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. + * 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] */ - style?: boolean; + 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] + */ + interface DocumentCreatedLoadOptions { /** - * 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. + 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: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - styleBuiltIn?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the text of the body. Use the insertText method to insert text. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiHiddenDocument 1.3] */ - text?: boolean; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * 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. + * 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: WordApiHiddenDocument 1.3] */ - type?: boolean; + saved?: boolean; } /** - * Represents the Border object for text, a paragraph, or a table. + * Represents document properties. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - interface BorderLoadOptions { + 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; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Gets the application name of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - color?: boolean; + applicationName?: boolean; /** - * Gets the location of the border. + * Specifies the author of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - location?: boolean; + author?: boolean; /** - * Specifies the border type for the border. + * Specifies the category of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - type?: boolean; + category?: boolean; /** - * Specifies whether the border is visible. + * 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: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - visible?: boolean; + comments?: boolean; /** - * Specifies the width for the border. + * Specifies the company of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - width?: boolean; - } - /** - * Represents the collection of border styles. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface BorderCollectionLoadOptions { - /** - 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.3] */ - $all?: boolean; + company?: 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. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - color?: boolean; + creationDate?: boolean; /** - * For EACH ITEM in the collection: Gets the location of the border. + * Specifies the format of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - location?: boolean; + format?: boolean; /** - * For EACH ITEM in the collection: Specifies the border type for the border. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - type?: boolean; + keywords?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * Gets the last author of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - visible?: boolean; + lastAuthor?: boolean; /** - * For EACH ITEM in the collection: Specifies the width for the border. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - width?: boolean; - } - /** - * Represents a break in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BreakLoadOptions { - /** - 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.3] */ - $all?: boolean; + lastPrintDate?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - range?: Word.Interfaces.RangeLoadOptions; + lastSaveTime?: boolean; /** - * Returns the page number on which the break occurs. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageIndex?: boolean; - } - /** - * Contains a collection of {@link Word.Break} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BreakCollectionLoadOptions { + manager?: 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 revision number of the document. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + revisionNumber?: boolean; /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. + * 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] */ - range?: Word.Interfaces.RangeLoadOptions; + security?: boolean; /** - * For EACH ITEM in the collection: Returns the page number on which the break occurs. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageIndex?: boolean; - } - /** - * The data specific to content controls of type CheckBox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface CheckboxContentControlLoadOptions { + subject?: 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 template of the document. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + template?: boolean; /** - * Specifies the current state of the checkbox. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - isChecked?: boolean; + title?: boolean; } /** - * Represents a comment in the document. + * 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}. */ - interface CommentLoadOptions { + 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; /** - * Specifies the comment's content range. + * Gets the parent body of the field. * * @remarks * [Api set: WordApi 1.4] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the email of the comment's author. + * 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] */ - authorEmail?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the name of the comment's author. + * 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] */ - authorName?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the comment's content as plain text. + * 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] */ - content?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the creation date of the comment. + * 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] */ - creationDate?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the ID of the comment. + * 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] */ - id?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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 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] */ - resolved?: boolean; - } - /** - * Contains a collection of {@link Word.Comment} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - 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; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment's content range. + * Gets the field's result data. * * @remarks * [Api set: WordApi 1.4] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + result?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the email of the comment's author. + * 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. */ - authorEmail?: boolean; + code?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment's author. + * 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.4] + * [Api set: WordApi 1.5] */ - authorName?: boolean; + data?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content as plain text. + * Gets the field's kind. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - content?: boolean; + kind?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - creationDate?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment. + * 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.4] + * [Api set: WordApiDesktop 1.1] */ - id?: boolean; + showCodes?: 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. + * Gets the field's type. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - resolved?: boolean; + 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}. */ - interface CommentContentRangeLoadOptions { + 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; /** - * Specifies a value that indicates whether the comment text is bold. + * For EACH ITEM in the collection: Gets the parent body of the field. * * @remarks * [Api set: WordApi 1.4] */ - bold?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * 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. + * 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] */ - hyperlink?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Checks whether the range length is zero. + * 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] */ - isEmpty?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a value that indicates whether the comment text is italicized. + * 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] */ - italic?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * 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] */ - strikeThrough?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the text of the comment range. + * 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] */ - text?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * 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] */ - 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`). - */ - $all?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the commentReply's content range. + * For EACH ITEM in the collection: Gets the field's result data. * * @remarks * [Api set: WordApi 1.4] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + result?: Word.Interfaces.RangeLoadOptions; /** - * Gets the parent comment of this reply. + * 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. */ - parentComment?: Word.Interfaces.CommentLoadOptions; + code?: boolean; /** - * Gets the email of the comment reply's author. + * 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.4] + * [Api set: WordApi 1.5] */ - authorEmail?: boolean; + data?: boolean; /** - * Gets the name of the comment reply's author. + * For EACH ITEM in the collection: Gets the field's kind. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - authorName?: boolean; + kind?: boolean; /** - * Specifies the comment reply's content. The string is plain text. + * 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.4] + * [Api set: WordApi 1.5] */ - content?: boolean; + locked?: boolean; /** - * Gets the creation date of the comment reply. + * For EACH ITEM in the collection: 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.4] + * [Api set: WordApiDesktop 1.1] */ - creationDate?: boolean; + showCodes?: boolean; /** - * Gets the ID of the comment reply. + * For EACH ITEM in the collection: Gets the field's type. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - id?: boolean; + type?: boolean; } /** - * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. + * Represents a font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - interface CommentReplyCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. + * 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.FillFormatLoadOptions; + /** + * 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.GlowFormatLoadOptions; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line?: Word.Interfaces.LineFormatLoadOptions; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reflection?: Word.Interfaces.ReflectionFormatLoadOptions; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textColor?: Word.Interfaces.ColorFormatLoadOptions; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textShadow?: Word.Interfaces.ShadowFormatLoadOptions; + /** + * 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.ThreeDimensionalFormatLoadOptions; + /** + * 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 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + allCaps?: boolean; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. + * 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.4] + * [Api set: WordApi 1.1] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + bold?: boolean; /** - * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: boolean; + boldBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * 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.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: boolean; + colorIndex?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + colorIndexBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment reply. + * Specifies whether contextual alternates are enabled for the font. * * @remarks - * [Api set: WordApi 1.4] - */ - id?: 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 { - /** - 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; + contextualAlternates?: 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 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 */ - customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + diacriticColor?: boolean; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; + disableCharacterSpaceGrid?: boolean; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * 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 */ - isMapped?: boolean; + emboss?: boolean; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - prefixMappings?: boolean; + emphasisMark?: boolean; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * 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 */ - xpath?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlPrefixMappingCollectionLoadOptions { + engrave?: 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 font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - $all?: boolean; + hidden?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * 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] */ - namespaceUri?: boolean; + highlightColor?: boolean; /** - * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - prefix?: boolean; - } - /** - * Represents a `CustomXmlPrefixMapping` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlPrefixMappingLoadOptions { + italic?: 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 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 */ - $all?: boolean; + italicBidirectional?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + kerning?: boolean; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies the ligature setting for the `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - prefix?: boolean; - } - /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlSchemaLoadOptions { + ligature?: 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 represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + name?: boolean; /** - * Gets the location of the schema on a computer. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - location?: boolean; + nameAscii?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Specifies the font name in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { - /** - 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; + nameBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the location of the schema on a computer. + * Specifies the East Asian font name. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - location?: boolean; + nameFarEast?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlValidationError} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlValidationErrorCollectionLoadOptions { + nameOther?: 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 number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + numberForm?: 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`. + * Specifies the number spacing setting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; + numberSpacing?: boolean; /** - * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * 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 */ - errorCode?: boolean; + outline?: 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` + * Specifies the position of text (in points) relative to the base line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + position?: boolean; /** - * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. + * Specifies the scaling percentage applied to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: boolean; + scaling?: boolean; /** - * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. + * 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 */ - type?: boolean; - } - /** - * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlValidationErrorLoadOptions { + shadow?: 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 represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + size?: boolean; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies the font size in points for right-to-left text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; + sizeBidirectional?: boolean; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * 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 */ - errorCode?: boolean; + smallCaps?: boolean; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Specifies the spacing between characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + spacing?: boolean; /** - * Gets the text in the `CustomXmlValidationError` object. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - text?: boolean; + strikeThrough?: boolean; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Specifies the stylistic set for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlNodeCollectionLoadOptions { + stylisticSet?: 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 font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + subscript?: 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`. + * 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] */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + superscript?: 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`. + * 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] */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + underline?: 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 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 */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + underlineColor?: boolean; + } + /** + * Represents a hyperlink in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface HyperlinkLoadOptions { /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + 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 within the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * 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`. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + address?: 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`. + * Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + emailSubject?: boolean; /** - * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + isExtraInfoRequired?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. + * Returns the name of the `Hyperlink` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Gets the type of the current node. + * 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 */ - nodeType?: boolean; + screenTip?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the current node. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + subAddress?: boolean; /** - * For EACH ITEM in the collection: Specifies the text for the current node. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: boolean; + target?: 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. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: boolean; + textToDisplay?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; + type?: boolean; } /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * Contains a collection of {@link Word.Hyperlink} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CustomXmlNodeLoadOptions { + interface HyperlinkCollectionLoadOptions { /** 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`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - firstChild?: 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: 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 */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * 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: Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + address?: boolean; /** - * Gets the object representing the part associated with this node. + * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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; + emailSubject?: boolean; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + isExtraInfoRequired?: boolean; /** - * Gets the unique address identifier for the namespace of the node. + * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + name?: boolean; /** - * Gets the type of the current node. + * For EACH ITEM in the collection: 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 */ - nodeType?: boolean; + screenTip?: boolean; /** - * Specifies the value of the current node. + * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + subAddress?: boolean; /** - * Specifies the text for the current node. + * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: boolean; + target?: 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: Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: boolean; + textToDisplay?: boolean; /** - * Gets the XML representation of the current node and its children. + * For EACH ITEM in the collection: Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; + type?: 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. + * Represents an inline picture. * * @remarks * [Api set: WordApi 1.1] */ - interface ContentControlLoadOptions { + 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 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. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Gets the parent body of the content control. + * Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * 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 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 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 content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * 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 content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * 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 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 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 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}. + * 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; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of 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] */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + altTextDescription?: boolean; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies a string that contains the title for the inline image. * * @remarks * [Api set: WordApi 1.1] */ - appearance?: boolean; + altTextTitle?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies a number that describes the height of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - cannotDelete?: boolean; + height?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks * [Api set: WordApi 1.1] */ - cannotEdit?: boolean; + hyperlink?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - color?: boolean; + imageFormat?: boolean; /** - * Gets an integer that represents the content control identifier. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks * [Api set: WordApi 1.1] */ - id?: boolean; + lockAspectRatio?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies a number that describes the width of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - placeholderText?: boolean; + width?: boolean; + } + /** + * Contains a collection of {@link Word.InlinePicture} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface InlinePictureCollectionLoadOptions { /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + 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.1] + * [Api set: WordApi 1.2] */ - removeWhenEdited?: boolean; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * 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. + * 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] */ - style?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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. + * 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] */ - styleBuiltIn?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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. + * 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] */ - subtype?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies a tag to identify a content control. + * 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] */ - tag?: boolean; + altTextDescription?: boolean; /** - * Gets the text of the content control. + * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. * * @remarks * [Api set: WordApi 1.1] */ - text?: boolean; + altTextTitle?: boolean; /** - * Specifies the title for a content control. + * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - title?: boolean; + height?: boolean; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * 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] */ - type?: boolean; + hyperlink?: boolean; + /** + * For EACH ITEM in the collection: Gets the format of the inline image. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + imageFormat?: 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.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. + * Contains a collection of {@link Word.Paragraph} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - interface ContentControlCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * Gets the list's id. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + id?: 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. + * 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.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontLoadOptions; + levelExistences?: boolean; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks * [Api set: WordApi 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + levelTypes?: boolean; + } + /** + * Contains a collection of {@link Word.List} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListCollectionLoadOptions { /** - * 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. + 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.1] + * [Api set: WordApi 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + id?: 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}. + * 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] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + levelExistences?: 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. + * 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] */ - parentTable?: Word.Interfaces.TableLoadOptions; + levelTypes?: boolean; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListItemLoadOptions { /** - * 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. + 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] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + level?: 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}. + * Gets the list item bullet, number, or picture as a string. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + listString?: 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}. + * Gets the list item order number in relation to its siblings. * * @remarks * [Api set: WordApi 1.3] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + siblingIndex?: boolean; + } + /** + * Represents a list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListLevelLoadOptions { /** - * 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. + 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 object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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] */ - appearance?: boolean; + alignment?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * 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] */ - cannotDelete?: boolean; + linkedStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - cannotEdit?: boolean; + numberFormat?: 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 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] */ - color?: boolean; + numberPosition?: boolean; /** - * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - id?: boolean; + numberStyle?: 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 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] */ - placeholderText?: boolean; + resetOnHigher?: 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 the starting number for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - removeWhenEdited?: boolean; + startAt?: 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 the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - style?: boolean; + tabPosition?: 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 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?: boolean; + textPosition?: 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 the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - subtype?: boolean; + trailingCharacter?: boolean; + } + /** + * Contains a collection of {@link Word.ListLevel} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListLevelCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies a tag to identify a 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; + /** + * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - tag?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the text of the content control. + * For EACH ITEM in the collection: 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] */ - text?: boolean; + alignment?: boolean; /** - * For EACH ITEM in the collection: Specifies the title for a content control. + * For EACH ITEM in the collection: 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] */ - title?: boolean; + linkedStyle?: boolean; /** - * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * For EACH ITEM in the collection: Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - type?: boolean; - } - /** - * Represents a list item in a dropdown list or combo box content control. - * - * @remarks - * [Api set: WordApi 1.9] - */ - interface ContentControlListItemLoadOptions { + numberFormat?: 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 position (in points) of the number or bullet for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] */ - $all?: boolean; + numberPosition?: boolean; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * For EACH ITEM in the collection: Specifies the number style for the list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberStyle?: boolean; + /** + * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + resetOnHigher?: boolean; + /** + * For EACH ITEM in the collection: Specifies the starting number for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + startAt?: boolean; + /** + * For EACH ITEM in the collection: Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.1] */ - displayText?: boolean; + tabPosition?: boolean; /** - * Specifies the index location of a content control list item in the collection of list items. + * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.1] */ - index?: boolean; + textPosition?: boolean; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.1] */ - value?: boolean; + trailingCharacter?: boolean; } /** - * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * Represents a ListTemplate. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.1] */ - interface ContentControlListItemCollectionLoadOptions { + interface ListTemplateLoadOptions { /** 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. + * Specifies whether the specified ListTemplate object is outline numbered. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.1] */ - value?: boolean; + outlineNumbered?: boolean; } /** - * Represents a custom property. + * Represents a footnote or endnote. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - interface CustomPropertyLoadOptions { + 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; /** - * Gets the key of the custom property. + * 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] + * [Api set: WordApi 1.5] */ - key?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - type?: boolean; + reference?: Word.Interfaces.RangeLoadOptions; /** - * 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). + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - value?: boolean; + type?: boolean; } /** - * Contains the collection of {@link Word.CustomProperty} objects. + * Contains a collection of {@link Word.NoteItem} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - interface CustomPropertyCollectionLoadOptions { + 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: Gets the key of the custom property. + * 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.3] + * [Api set: WordApi 1.5] */ - key?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - type?: boolean; + reference?: Word.Interfaces.RangeLoadOptions; /** - * 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). + * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - value?: boolean; + type?: boolean; } /** - * Represents a custom XML part. + * Represents a page in the document. `Page` objects manage the page layout and content. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - interface CustomXmlPartLoadOptions { + interface PageLoadOptions { /** 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 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.CustomXmlNodeLoadOptions; - /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - builtIn?: boolean; - /** - * Gets the ID of the custom XML part. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - id?: boolean; + height?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - namespaceUri?: boolean; + index?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Gets the width, 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] */ - xml?: boolean; + width?: boolean; } /** - * Contains the collection of {@link Word.CustomXmlPart} objects. + * Represents the collection of page. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - interface CustomXmlPartCollectionLoadOptions { + interface PageCollectionLoadOptions { /** 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 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.CustomXmlNodeLoadOptions; - /** - * 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 - */ - builtIn?: boolean; - /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - id?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - namespaceUri?: boolean; + index?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * For EACH ITEM in the collection: Gets the width, 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] */ - xml?: boolean; + width?: boolean; } /** - * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * Represents a single paragraph in a selection, range, content control, or document body. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - interface CustomXmlPartScopedCollectionLoadOptions { + 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; /** - * 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 text format of the paragraph. 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] */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * 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] */ - builtIn?: boolean; + list?: Word.Interfaces.ListLoadOptions; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - id?: boolean; + listItem?: Word.Interfaces.ListItemLoadOptions; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * 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.4] + * [Api set: WordApi 1.3] */ - namespaceUri?: boolean; + listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - 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 { + listOrNullObject?: Word.Interfaces.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`). + * Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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] */ - body?: Word.Interfaces.BodyLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the properties of the document. + * 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] */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the ChangeTracking mode. + * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - changeTrackingMode?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * 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 table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @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] - */ - 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`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the properties of the document. + * 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: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.3] */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * 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. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - saved?: boolean; - } - /** - * Represents document properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets the application name of the document. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - applicationName?: boolean; + alignment?: boolean; /** - * Specifies the author of the document. + * 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.3] + * [Api set: WordApi 1.1] */ - author?: boolean; + firstLineIndent?: boolean; /** - * Specifies the category of the document. + * Indicates the paragraph is the last one inside its parent body. * * @remarks * [Api set: WordApi 1.3] */ - category?: boolean; + isLastParagraph?: boolean; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Checks whether the paragraph is a list item. * * @remarks * [Api set: WordApi 1.3] */ - comments?: boolean; + isListItem?: boolean; /** - * Specifies the company of the document. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - company?: boolean; + leftIndent?: boolean; /** - * Gets the creation date of the 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 1.3] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + lineSpacing?: boolean; /** - * Specifies the format of the document. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - format?: boolean; + lineUnitAfter?: boolean; /** - * Specifies the keywords of the document. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - keywords?: boolean; + lineUnitBefore?: boolean; /** - * Gets the last author of the document. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lastAuthor?: boolean; + outlineLevel?: boolean; /** - * Gets the last print date of the document. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lastPrintDate?: boolean; + rightIndent?: boolean; /** - * Gets the last save time of the document. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lastSaveTime?: boolean; + spaceAfter?: boolean; /** - * Specifies the manager of the document. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - manager?: boolean; + spaceBefore?: boolean; /** - * Gets the revision number of the document. + * 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.3] + * [Api set: WordApi 1.1] */ - revisionNumber?: boolean; + style?: 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. + * 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] */ - security?: boolean; + styleBuiltIn?: boolean; /** - * Specifies the subject of the document. + * 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] */ - subject?: boolean; + tableNestingLevel?: boolean; /** - * Gets the template of the document. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - template?: boolean; + text?: boolean; /** - * Specifies the title of the document. + * 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.3] + * [Api set: WordApi 1.6] */ - title?: boolean; + uniqueLocalId?: boolean; } /** - * Represents a field. + * Contains a collection of {@link Word.Paragraph} 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}. + * [Api set: WordApi 1.1] */ - interface FieldLoadOptions { + 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; /** - * Gets the parent body of the field. + * 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.4] + * [Api set: WordApi 1.1] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * 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.4] + * [Api set: WordApi 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + list?: Word.Interfaces.ListLoadOptions; /** - * 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}. + * 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.4] + * [Api set: WordApi 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + listItem?: Word.Interfaces.ListItemLoadOptions; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * 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.4] + * [Api set: WordApi 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; + listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * 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.4] + * [Api set: WordApi 1.3] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * 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}. + * For EACH ITEM in the collection: Gets the parent body of the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * 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}. + * 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.4] + * [Api set: WordApi 1.1] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the field's result data. + * 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.4] + * [Api set: WordApi 1.3] */ - result?: Word.Interfaces.RangeLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the field's code instruction. + * 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.4] + * [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. * - * Note: The ability to set the code was introduced in WordApi 1.5. + * @remarks + * [Api set: WordApi 1.3] */ - code?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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. + * 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.5] + * [Api set: WordApi 1.3] */ - data?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the field's kind. + * 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.5] + * [Api set: WordApi 1.3] */ - kind?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - showCodes?: boolean; + alignment?: boolean; /** - * Gets the field's type. + * 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.5] + * [Api set: WordApi 1.1] */ - 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}. - */ - interface FieldCollectionLoadOptions { + firstLineIndent?: 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: Indicates the paragraph is the last one inside its parent body. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + isLastParagraph?: boolean; /** - * For EACH ITEM in the collection: Gets the parent body of the field. + * For EACH ITEM in the collection: Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + isListItem?: boolean; /** - * 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. + * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + leftIndent?: boolean; /** - * 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}. + * 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.4] + * [Api set: WordApi 1.1] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + lineSpacing?: boolean; /** - * 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. + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentTable?: Word.Interfaces.TableLoadOptions; + lineUnitAfter?: boolean; /** - * 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. + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + lineUnitBefore?: boolean; /** - * 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}. + * For EACH ITEM in the collection: Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + outlineLevel?: boolean; /** - * 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}. + * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + rightIndent?: boolean; /** - * For EACH ITEM in the collection: Gets the field's result data. + * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeLoadOptions; + spaceAfter?: boolean; /** - * For EACH ITEM in the collection: Specifies the field's code instruction. + * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. * * @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?: boolean; + spaceBefore?: 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. + * 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.5] + * [Api set: WordApi 1.1] */ - data?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Gets the field's kind. + * 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.5] + * [Api set: WordApi 1.3] */ - kind?: boolean; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * 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.5] + * [Api set: WordApi 1.3] */ - locked?: boolean; + tableNestingLevel?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * For EACH ITEM in the collection: Gets the text of the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - showCodes?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the field's type. + * 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.5] + * [Api set: WordApi 1.6] */ - type?: boolean; + uniqueLocalId?: boolean; } /** - * Represents a font. + * Represents a style of paragraph in a document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - interface FontLoadOptions { + 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; /** - * 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.FillFormatLoadOptions; - /** - * 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.GlowFormatLoadOptions; - /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - line?: Word.Interfaces.LineFormatLoadOptions; - /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - reflection?: Word.Interfaces.ReflectionFormatLoadOptions; - /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textColor?: Word.Interfaces.ColorFormatLoadOptions; - /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textShadow?: Word.Interfaces.ShadowFormatLoadOptions; - /** - * 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.ThreeDimensionalFormatLoadOptions; - /** - * 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. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - allCaps?: boolean; + alignment?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, 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.1] + * [Api set: WordApi 1.5] */ - bold?: boolean; + firstLineIndent?: 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. + * 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] */ - boldBidirectional?: boolean; + keepTogether?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * 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.1] + * [Api set: WordApi 1.5] */ - color?: boolean; + keepWithNext?: boolean; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies the left indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - colorIndex?: boolean; + leftIndent?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - colorIndexBidirectional?: boolean; + lineSpacing?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - contextualAlternates?: boolean; + lineUnitAfter?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - diacriticColor?: boolean; + lineUnitBefore?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - disableCharacterSpaceGrid?: boolean; + mirrorIndents?: 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 outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - doubleStrikeThrough?: boolean; + outlineLevel?: 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. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - emboss?: boolean; + rightIndent?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - emphasisMark?: boolean; + spaceAfter?: 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 the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - engrave?: boolean; + spaceBefore?: boolean; /** - * 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 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.2] + * [Api set: WordApi 1.5] */ - hidden?: boolean; + widowControl?: boolean; + } + /** + * Represents a contiguous area in a document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface RangeLoadOptions { /** - * 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] + 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`). */ - highlightColor?: boolean; + $all?: boolean; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * 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] */ - 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; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - kerning?: boolean; + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * Specifies the ligature setting for the `Font` object. + * Gets the parent body of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - ligature?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies a value that represents the name of the font. + * 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] */ - name?: boolean; - /** - * 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?: boolean; - /** - * Specifies the font name in a right-to-left language document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - nameBidirectional?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the East Asian font name. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nameFarEast?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the font used for characters with codes from 128 through 255. + * Gets the table that contains the range. 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] */ - nameOther?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the number form setting for an OpenType font. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - numberForm?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the number spacing setting for the font. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - numberSpacing?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - outline?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the position of text (in points) relative to the base line. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the scaling percentage applied to the font. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling?: boolean; + hasNoProofing?: 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. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - shadow?: boolean; + hyperlink?: boolean; /** - * Specifies a value that represents the font size in points. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - size?: boolean; + isEmpty?: boolean; /** - * Specifies the font size in points for right-to-left text. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional?: boolean; + languageDetected?: 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 a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + languageId?: boolean; /** - * Specifies the spacing between characters. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: 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; + languageIdFarEast?: boolean; /** - * Specifies the stylistic set for the font. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stylisticSet?: boolean; + languageIdOther?: boolean; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * 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] */ - subscript?: boolean; + style?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * 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.1] + * [Api set: WordApi 1.3] */ - superscript?: boolean; + styleBuiltIn?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Gets the text of the range. * * @remarks * [Api set: WordApi 1.1] */ - underline?: boolean; - /** - * 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?: boolean; + text?: boolean; } /** - * Represents a hyperlink in a Word document. + * Contains a collection of {@link Word.Range} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - interface HyperlinkLoadOptions { + 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; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - range?: Word.Interfaces.RangeLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - address?: boolean; + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * Specifies the text string for the hyperlink's subject line. + * For EACH ITEM in the collection: Gets the parent body of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - emailSubject?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isExtraInfoRequired?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns the name of the `Hyperlink` object. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - screenTip?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies a named location in the destination of the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - subAddress?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - target?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the hyperlink's visible text in the document. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textToDisplay?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Returns the hyperlink type. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.Hyperlink} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface HyperlinkCollectionLoadOptions { - /** - 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; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + hasNoProofing?: boolean; /** - * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - address?: boolean; + hyperlink?: boolean; /** - * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. + * For EACH ITEM in the collection: Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - emailSubject?: boolean; + isEmpty?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. + * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtraInfoRequired?: boolean; + languageDetected?: boolean; /** - * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + languageId?: boolean; /** - * For EACH ITEM in the collection: Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * For EACH ITEM in the collection: Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: boolean; + languageIdFarEast?: boolean; /** - * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. + * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: boolean; + languageIdOther?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - target?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textToDisplay?: boolean; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Returns the hyperlink type. + * For EACH ITEM in the collection: Gets the text of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: boolean; + text?: boolean; } /** - * Represents an inline picture. + * 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] */ - interface InlinePictureLoadOptions { + 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; /** - * Gets the parent paragraph that contains the inline image. + * 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.2] + * [Api set: WordApi 1.1] */ - paragraph?: Word.Interfaces.ParagraphLoadOptions; + ignorePunct?: boolean; /** - * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * 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] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + ignoreSpace?: boolean; /** - * 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 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] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + matchCase?: boolean; /** - * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * 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] */ - parentTable?: Word.Interfaces.TableLoadOptions; + matchPrefix?: boolean; /** - * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * 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] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + matchSuffix?: boolean; /** - * 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}. + * 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] + * [Api set: WordApi 1.1] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + matchWholeWord?: boolean; /** - * 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}. + * 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.3] + * [Api set: WordApi 1.1] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + matchWildcards?: boolean; + } + /** + * Represents a section in a Word document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface SectionLoadOptions { /** - * Specifies a string that represents the alternative text associated with the inline image. + 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] */ - altTextDescription?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Specifies a string that contains the title for the inline image. + * Returns a `PageSetup` object that's associated with the section. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: boolean; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Specifies a number that describes the height of the inline image. + * Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: boolean; + protectedForForms?: boolean; + } + /** + * Contains the collection of the document's {@link Word.Section} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface SectionCollectionLoadOptions { /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + 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] */ - hyperlink?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the format of the inline image. + * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupLoadOptions; + /** + * For EACH ITEM in the collection: Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: boolean; + protectedForForms?: boolean; + } + /** + * Represents a setting of the add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface SettingLoadOptions { /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + 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.1] + * [Api set: WordApi 1.4] */ - lockAspectRatio?: boolean; + key?: boolean; /** - * Specifies a number that describes the width of the inline image. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - width?: boolean; + value?: boolean; } /** - * Contains a collection of {@link Word.InlinePicture} objects. + * Contains the collection of {@link Word.Setting} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - interface InlinePictureCollectionLoadOptions { + 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 parent paragraph that contains the inline image. + * For EACH ITEM in the collection: Gets the key of the setting. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.4] */ - paragraph?: Word.Interfaces.ParagraphLoadOptions; + key?: boolean; /** - * 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. + * For EACH ITEM in the collection: Specifies the value of the setting. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + value?: boolean; + } + /** + * Contains a collection of {@link Word.Style} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface StyleCollectionLoadOptions { /** - * 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}. + 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 a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTable?: Word.Interfaces.TableLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + frame?: Word.Interfaces.FrameLoadOptions; /** - * 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}. + * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * 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}. + * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. + * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - altTextDescription?: boolean; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. + * 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.1] + * [Api set: WordApi 1.6] */ - altTextTitle?: boolean; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. + * 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.1] + * [Api set: WordApi 1.6] */ - height?: boolean; + tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** - * For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: boolean; + automaticallyUpdate?: boolean; /** - * For EACH ITEM in the collection: Gets the format of the inline image. + * 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: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - imageFormat?: boolean; + baseStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - lockAspectRatio?: boolean; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. + * For EACH ITEM in the collection: Gets the description of the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; - } - /** - * Contains a collection of {@link Word.Paragraph} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ListLoadOptions { + description?: 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 whether the spelling and grammar checker ignores text formatted with this style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + hasProofing?: boolean; /** - * Gets the list's id. + * 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.3] + * [Api set: WordApi 1.5] */ - id?: boolean; + inUse?: 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. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean; + languageId?: boolean; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * For EACH ITEM in the collection: Specifies an East Asian language for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelTypes?: boolean; - } - /** - * Contains a collection of {@link Word.List} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ListCollectionLoadOptions { + languageIdFarEast?: 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 whether a style is a linked style that can be used for both paragraph and character formatting. + * + * @remarks + * [Api set: WordApi 1.5] */ - $all?: boolean; + linked?: boolean; /** - * For EACH ITEM in the collection: Gets the list's id. + * For EACH ITEM in the collection: Returns the list level for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + listLevelNumber?: 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. + * For EACH ITEM in the collection: Specifies whether the style cannot be changed or edited. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * For EACH ITEM in the collection: Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - levelTypes?: boolean; - } - /** - * Represents the paragraph list item format. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ListItemLoadOptions { + nameLocal?: 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 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. */ - $all?: boolean; + nextParagraphStyle?: boolean; /** - * Specifies the level of the item in the list. + * For EACH ITEM in the collection: Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * For EACH ITEM in the collection: Specifies the priority. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listString?: boolean; + priority?: boolean; /** - * Gets the list item order number in relation to its siblings. + * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - siblingIndex?: boolean; + 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 list level. + * Represents a style in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - interface ListLevelLoadOptions { + 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 object. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks * [Api set: WordApiDesktop 1.1] */ - font?: Word.Interfaces.FontLoadOptions; + borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - alignment?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the name of the style that's linked to the specified list level object. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: boolean; + frame?: Word.Interfaces.FrameLoadOptions; /** - * Specifies the number format for the specified list level. + * Specifies a link between a paragraph and a character style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: boolean; + linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - numberPosition?: boolean; + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * Specifies the number style for the list level object. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - numberStyle?: boolean; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - resetOnHigher?: boolean; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * Specifies the starting number for the specified list level object. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - startAt?: boolean; + tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** - * Specifies the tab position for the specified list level object. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: boolean; + automaticallyUpdate?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - textPosition?: boolean; - /** - * Specifies the character inserted after the number for the specified list level. + * [Api set: WordApi 1.5] * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - trailingCharacter?: boolean; - } - /** - * Contains a collection of {@link Word.ListLevel} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface ListLevelCollectionLoadOptions { - /** - 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`). + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - $all?: boolean; + baseStyle?: boolean; /** - * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontLoadOptions; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Gets the description of the specified style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + description?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: boolean; + hasProofing?: boolean; /** - * For EACH ITEM in the collection: Specifies the number format for the specified list level. + * 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: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - numberFormat?: boolean; + inUse?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: boolean; + languageId?: boolean; /** - * For EACH ITEM in the collection: Specifies the number style for the list level object. + * Specifies an East Asian language for the style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: boolean; + languageIdFarEast?: boolean; /** - * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - resetOnHigher?: boolean; + linked?: boolean; /** - * For EACH ITEM in the collection: Specifies the starting number for the specified list level object. + * Returns the list level for the style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: boolean; + listLevelNumber?: boolean; /** - * For EACH ITEM in the collection: Specifies the tab position for the specified list level object. + * Specifies whether the style cannot be changed or edited. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - textPosition?: boolean; + nameLocal?: boolean; /** - * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level. + * 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: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - trailingCharacter?: boolean; - } - /** - * Represents a ListTemplate. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface ListTemplateLoadOptions { + nextParagraphStyle?: 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 to remove spacing between paragraphs that are formatted using the same style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies whether the specified ListTemplate object is outline numbered. + * Specifies the priority. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - outlineNumbered?: boolean; - } - /** - * Represents a footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface NoteItemLoadOptions { + priority?: 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 the style corresponds to an available quick style. + * + * @remarks + * [Api set: WordApi 1.5] */ - $all?: boolean; + quickStyle?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets the style type. * * @remarks * [Api set: WordApi 1.5] */ - body?: Word.Interfaces.BodyLoadOptions; + type?: boolean; /** - * Represents a footnote or endnote reference in the main document. + * 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] */ - reference?: Word.Interfaces.RangeLoadOptions; + unhideWhenUsed?: boolean; /** - * Represents the note item type: footnote or endnote. + * 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] */ - type?: boolean; + visibility?: boolean; } /** - * Contains a collection of {@link Word.NoteItem} objects. + * Represents the shading object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - interface NoteItemCollectionLoadOptions { + 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; /** - * 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. + * 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] */ - body?: Word.Interfaces.BodyLoadOptions; + backgroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main 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] */ - reference?: Word.Interfaces.RangeLoadOptions; + foregroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. + * 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] */ - type?: boolean; + texture?: boolean; } /** - * Represents a page in the document. `Page` objects manage the page layout and content. + * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface PageLoadOptions { + interface ShadingUniversalLoadOptions { /** 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 height, in points, of the paper defined in the Page Setup dialog box. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: boolean; + backgroundPatternColor?: boolean; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + backgroundPatternColorIndex?: boolean; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + foregroundPatternColor?: boolean; + /** + * 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 + */ + foregroundPatternColorIndex?: 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}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + texture?: boolean; } /** - * Represents the collection of page. + * Represents a table in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - interface PageCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - height?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Gets the parent body of the table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - index?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - width?: boolean; - } - /** - * Represents a single paragraph in a selection, range, content control, or document body. - * - * @remarks - * [Api set: WordApi 1.1] - */ - 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`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * 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.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * 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] */ - list?: Word.Interfaces.ListLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * 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] */ - listItem?: Word.Interfaces.ListItemLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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 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] */ - listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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 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] */ - listOrNullObject?: Word.Interfaces.ListLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the parent body of the paragraph. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks * [Api set: WordApi 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + alignment?: boolean; /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + headerRowCount?: boolean; /** - * 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}. + * 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] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + horizontalAlignment?: boolean; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * Indicates whether all of the table rows are uniform. * * @remarks * [Api set: WordApi 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; + isUniform?: boolean; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + nestingLevel?: boolean; /** - * 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 number of rows in the table. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + rowCount?: boolean; /** - * 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}. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks * [Api set: WordApi 1.3] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + shadingColor?: boolean; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * 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.1] + * [Api set: WordApi 1.3] */ - alignment?: boolean; + style?: 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 table has banded columns. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - firstLineIndent?: boolean; + styleBandedColumns?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Specifies whether the table has banded rows. * * @remarks * [Api set: WordApi 1.3] */ - isLastParagraph?: boolean; + styleBandedRows?: boolean; /** - * Checks whether the paragraph is a list item. + * 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] */ - isListItem?: boolean; + styleBuiltIn?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - leftIndent?: boolean; + styleFirstColumn?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineSpacing?: boolean; + styleLastColumn?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineUnitAfter?: boolean; + styleTotalRow?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineUnitBefore?: boolean; + values?: boolean; /** - * Specifies the outline level for the paragraph. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - outlineLevel?: boolean; + verticalAlignment?: boolean; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + width?: boolean; + } + /** + * Represents the TableStyle object. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface TableStyleLoadOptions { /** - * Specifies the spacing, in points, after the paragraph. + 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's alignment against the page margin. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - spaceAfter?: boolean; + alignment?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - spaceBefore?: boolean; + allowBreakAcrossPage?: 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 the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - style?: boolean; + bottomCellMargin?: 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 spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleBuiltIn?: boolean; + cellSpacing?: boolean; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - tableNestingLevel?: boolean; + leftCellMargin?: boolean; /** - * Gets the text of the paragraph. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - text?: boolean; + rightCellMargin?: 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. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks * [Api set: WordApi 1.6] */ - uniqueLocalId?: boolean; + topCellMargin?: boolean; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Contains the collection of the document's Table objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - interface ParagraphCollectionLoadOptions { + 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 text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * 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.1] + * [Api set: WordApi 1.3] */ 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. + * For EACH ITEM in the collection: Gets the parent body of the table. * * @remarks * [Api set: WordApi 1.3] */ - list?: Word.Interfaces.ListLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * 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. + * 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] */ - listItem?: Word.Interfaces.ListItemLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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}. + * 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] */ - listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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}. + * 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] */ - listOrNullObject?: Word.Interfaces.ListLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the paragraph. + * 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] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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. + * 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.1] + * [Api set: WordApi 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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}. + * 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] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * 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. + * 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] */ - parentTable?: Word.Interfaces.TableLoadOptions; + alignment?: boolean; /** - * 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. + * For EACH ITEM in the collection: Specifies the number of header rows. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + headerRowCount?: boolean; /** - * 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}. + * 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] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + horizontalAlignment?: boolean; /** - * 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}. + * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. * * @remarks * [Api set: WordApi 1.3] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + isUniform?: boolean; /** - * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - alignment?: boolean; + nestingLevel?: 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. + * For EACH ITEM in the collection: Gets the number of rows in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - firstLineIndent?: boolean; + rowCount?: boolean; /** - * For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body. + * 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] */ - isLastParagraph?: boolean; + shadingColor?: boolean; /** - * For EACH ITEM in the collection: Checks whether the paragraph is a list item. + * 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] */ - isListItem?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. + * For EACH ITEM in the collection: Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - leftIndent?: boolean; + styleBandedColumns?: 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. + * For EACH ITEM in the collection: Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineSpacing?: boolean; + styleBandedRows?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. + * 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.1] + * [Api set: WordApi 1.3] */ - lineUnitAfter?: boolean; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. + * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineUnitBefore?: boolean; + styleFirstColumn?: boolean; /** - * For EACH ITEM in the collection: Specifies the outline level for the paragraph. + * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - outlineLevel?: boolean; + styleLastColumn?: boolean; /** - * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. + * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + styleTotalRow?: boolean; /** - * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. + * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - spaceAfter?: boolean; + values?: boolean; /** - * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. + * 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.1] + * [Api set: WordApi 1.3] */ - spaceBefore?: boolean; + verticalAlignment?: 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. + * For EACH ITEM in the collection: Specifies the width of the table in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + width?: boolean; + } + /** + * Represents a table column in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableColumnLoadOptions { + /** + 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 `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * Returns the position of this column in a collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columnIndex?: boolean; + /** + * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFirst?: boolean; + /** + * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLast?: 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. + * Returns the nesting level of the column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + nestingLevel?: 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. + * 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableNestingLevel?: boolean; + preferredWidth?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the paragraph. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + preferredWidthType?: 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. + * Specifies the width of the column, in points. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalId?: boolean; + width?: boolean; } /** - * Represents a style of paragraph in a document. + * Represents a collection of {@link Word.TableColumn} objects in a Word document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ParagraphFormatLoadOptions { + interface TableColumnCollectionLoadOptions { /** 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. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Returns the position of this column in a collection. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: boolean; + columnIndex?: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * For EACH ITEM in the collection: Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + isFirst?: boolean; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * For EACH ITEM in the collection: Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + isLast?: boolean; /** - * Specifies the left indent. + * For EACH ITEM in the collection: Returns the nesting level of the column. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: boolean; + nestingLevel?: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * For EACH ITEM in the collection: 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 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: boolean; + preferredWidth?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * For EACH ITEM in the collection: Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: boolean; + preferredWidthType?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * For EACH ITEM in the collection: Specifies the width of the column, in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: boolean; + width?: boolean; + } + /** + * Represents a row in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface TableRowLoadOptions { /** - * Specifies whether left and right indents are the same width. - * - * @remarks - * [Api set: WordApi 1.5] + 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`). */ - mirrorIndents?: boolean; + $all?: boolean; /** - * Specifies the outline level 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] */ - outlineLevel?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Gets parent table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceAfter?: boolean; + cellCount?: boolean; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceBefore?: boolean; + horizontalAlignment?: 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. + * 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.5] + * [Api set: WordApi 1.3] */ - widowControl?: boolean; - } - /** - * Represents a contiguous area in a document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface RangeLoadOptions { + isHeader?: 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 preferred height of the row in points. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + preferredHeight?: boolean; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listFormat?: Word.Interfaces.ListFormatLoadOptions; + rowIndex?: boolean; /** - * Gets the parent body of the range. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks * [Api set: WordApi 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + shadingColor?: boolean; /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + values?: boolean; /** - * 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}. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks * [Api set: WordApi 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + verticalAlignment?: boolean; + } + /** + * Contains the collection of the document's TableRow objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface TableRowCollectionLoadOptions { /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + 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] */ - parentTable?: Word.Interfaces.TableLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * For EACH ITEM in the collection: Gets parent table. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * 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}. + * For EACH ITEM in the collection: Gets the number of cells in the row. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + cellCount?: boolean; /** - * 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}. + * 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] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + horizontalAlignment?: boolean; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - hasNoProofing?: boolean; + isHeader?: 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. Use a '#' to separate the address part from the optional location part. + * For EACH ITEM in the collection: Specifies the preferred height of the row in points. * * @remarks * [Api set: WordApi 1.3] */ - hyperlink?: boolean; + preferredHeight?: boolean; /** - * Checks whether the range length is zero. + * For EACH ITEM in the collection: Gets the index of the row in its parent table. * * @remarks * [Api set: WordApi 1.3] */ - isEmpty?: boolean; + rowIndex?: 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. + * 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.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + shadingColor?: 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. + * For EACH ITEM in the collection: Specifies the text values in the row, as a 2D JavaScript array. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + values?: boolean; /** - * Gets the text of the range. + * 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.1] + * [Api set: WordApi 1.3] */ - text?: boolean; + verticalAlignment?: boolean; } /** - * Contains a collection of {@link Word.Range} objects. + * Represents a table cell in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - interface RangeCollectionLoadOptions { + 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; /** - * 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: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listFormat?: Word.Interfaces.ListFormatLoadOptions; - /** - * For EACH ITEM in the collection: Gets the parent body of the range. + * Gets the body object of the cell. * * @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; + body?: Word.Interfaces.BodyLoadOptions; /** - * 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}. + * Gets the parent row of the cell. * * @remarks * [Api set: WordApi 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * 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. + * 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 table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the index of the cell in its row. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + cellIndex?: boolean; /** - * 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}. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + columnWidth?: boolean; /** - * 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}. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks * [Api set: WordApi 1.3] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; - /** - * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hasNoProofing?: boolean; + horizontalAlignment?: boolean; /** - * 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. + * Gets the index of the cell's row in the table. * * @remarks * [Api set: WordApi 1.3] */ - hyperlink?: boolean; + rowIndex?: boolean; /** - * For EACH ITEM in the collection: Checks whether the range length is zero. + * 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] */ - isEmpty?: boolean; + shadingColor?: 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. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + value?: 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. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + verticalAlignment?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the range. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - text?: boolean; + width?: 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}. + * Contains the collection of the document's TableCell objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - interface SearchOptionsLoadOptions { + 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; /** - * 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. + * For EACH ITEM in the collection: Gets the body object of the cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - ignorePunct?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Gets the parent row of the cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - ignoreSpace?: boolean; + parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Gets the parent table of the cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchCase?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchPrefix?: boolean; + cellIndex?: 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. + * 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.1] + * [Api set: WordApi 1.3] */ - matchSuffix?: boolean; + columnWidth?: 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. + * 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.1] + * [Api set: WordApi 1.3] */ - matchWholeWord?: boolean; + horizontalAlignment?: 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. + * For EACH ITEM in the collection: Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApi 1.1] - */ - matchWildcards?: boolean; - } - /** - * Represents a section in a Word document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - 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`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + rowIndex?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * 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.1] - */ - body?: Word.Interfaces.BodyLoadOptions; - } - /** - * Contains the collection of the document's {@link Word.Section} objects. - * - * @remarks - * [Api set: WordApi 1.1] - */ - 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`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + shadingColor?: 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. + * For EACH ITEM in the collection: Specifies the text of the cell. * * @remarks - * [Api set: WordApi 1.1] - */ - body?: Word.Interfaces.BodyLoadOptions; - } - /** - * Represents a setting of the add-in. - * - * @remarks - * [Api set: WordApi 1.4] - */ - 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`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + value?: boolean; /** - * Gets the key of the setting. + * 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.4] + * [Api set: WordApi 1.3] */ - key?: boolean; + verticalAlignment?: boolean; /** - * Specifies the value of the setting. + * For EACH ITEM in the collection: Gets the width of the cell in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - value?: boolean; + width?: boolean; } /** - * Contains the collection of {@link Word.Setting} objects. + * Specifies the border style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - interface SettingCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets the key of the setting. + * Specifies the table border color. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - key?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the setting. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - value?: boolean; + 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; } /** - * Contains a collection of {@link Word.Style} objects. + * Represents a document template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface StyleCollectionLoadOptions { + interface TemplateLoadOptions { /** 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 a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - borders?: Word.Interfaces.BorderCollectionLoadOptions; - /** - * 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 ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; - /** - * 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. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingLoadOptions; + farEastLineBreakLanguage?: boolean; /** - * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleLoadOptions; + farEastLineBreakLevel?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style. + * Returns the name of the template, including the drive or Web path. * * @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?: boolean; + fullName?: boolean; /** - * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - builtIn?: boolean; + hasNoProofing?: boolean; /** - * For EACH ITEM in the collection: Gets the description of the specified style. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: boolean; + justificationMode?: 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. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inUse?: boolean; + kerningByAlgorithm?: 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. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linked?: boolean; + languageId?: boolean; /** - * For EACH ITEM in the collection: Gets the name of a style in the language of the user. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nameLocal?: boolean; + languageIdFarEast?: 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. + * Returns only the name of the document template (excluding any path or other location information). * * @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?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Specifies the priority. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: boolean; + noLineBreakAfter?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle?: boolean; + noLineBreakBefore?: boolean; /** - * For EACH ITEM in the collection: Gets the style type. + * Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + path?: 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. + * 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.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + saved?: 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. + * Returns the template type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; + type?: boolean; } /** - * Represents a style in a Word document. + * 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 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface StyleLoadOptions { + interface TemplateCollectionLoadOptions { /** 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 BorderCollection object that represents all the borders for the specified style. + * For EACH ITEM in the collection: Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderCollectionLoadOptions; + farEastLineBreakLanguage?: boolean; /** - * Gets a font object that represents the character formatting of the specified style. + * For EACH ITEM in the collection: Specifies the line break control level for the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + farEastLineBreakLevel?: boolean; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * For EACH ITEM in the collection: Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + fullName?: boolean; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; + hasNoProofing?: boolean; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * For EACH ITEM in the collection: Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingLoadOptions; + justificationMode?: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * For EACH ITEM in the collection: Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleLoadOptions; + kerningByAlgorithm?: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language in the template. * * @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?: boolean; + languageId?: boolean; /** - * Gets whether the specified style is a built-in style. + * For EACH ITEM in the collection: Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - builtIn?: boolean; + languageIdFarEast?: boolean; /** - * Gets the description of the specified style. + * For EACH ITEM in the collection: Returns only the name of the document template (excluding any path or other location information). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: boolean; + name?: 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. + * For EACH ITEM in the collection: Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inUse?: boolean; + noLineBreakAfter?: boolean; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * For EACH ITEM in the collection: Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linked?: boolean; + noLineBreakBefore?: boolean; /** - * Gets the name of a style in the language of the user. + * For EACH ITEM in the collection: Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nameLocal?: boolean; + path?: 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. + * For EACH ITEM in the collection: 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.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nextParagraphStyle?: boolean; + saved?: boolean; /** - * Specifies the priority. + * For EACH ITEM in the collection: Returns the template type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: boolean; + type?: boolean; + } + /** + * Represents a tracked change in a Word document. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface TrackedChangeLoadOptions { /** - * Specifies whether the style corresponds to an available quick style. + 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.5] + * [Api set: WordApi 1.6] */ - quickStyle?: boolean; + author?: boolean; /** - * Gets the style type. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - type?: boolean; + date?: 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. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - unhideWhenUsed?: boolean; + text?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - visibility?: boolean; + type?: boolean; } /** - * Represents the shading object. + * Contains a collection of {@link Word.TrackedChange} objects. * * @remarks * [Api set: WordApi 1.6] */ - interface ShadingLoadOptions { + 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; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Gets the author of the tracked change. * * @remarks * [Api set: WordApi 1.6] */ - backgroundPatternColor?: boolean; + author?: boolean; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Gets the date of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - foregroundPatternColor?: boolean; + date?: 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}. + * For EACH ITEM in the collection: Gets the text of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - texture?: boolean; + text?: boolean; + /** + * For EACH ITEM in the collection: Gets the type of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type?: boolean; } /** - * Represents a table in a Word document. + * 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface TableLoadOptions { + interface ShapeLoadOptions { /** 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. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the parent body of the table. + * 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] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + canvas?: Word.Interfaces.CanvasLoadOptions; /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + fill?: Word.Interfaces.ShapeFillLoadOptions; /** - * 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 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + parentCanvas?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTable?: Word.Interfaces.TableLoadOptions; + parentGroup?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; /** - * 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 text frame object of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + textFrame?: Word.Interfaces.TextFrameLoadOptions; /** - * 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}. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - alignment?: boolean; + allowOverlap?: boolean; /** - * Specifies the number of header rows. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - headerRowCount?: boolean; + altTextDescription?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: boolean; + geometricShapeType?: boolean; /** - * Indicates whether all of the table rows are uniform. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isUniform?: boolean; + height?: boolean; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * 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] */ - nestingLevel?: boolean; + heightRelative?: boolean; /** - * Gets the number of rows in the table. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowCount?: boolean; + id?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: boolean; + isChild?: 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. + * 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] */ - style?: boolean; + left?: boolean; /** - * Specifies whether the table has banded columns. + * 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] */ - styleBandedColumns?: boolean; + leftRelative?: boolean; /** - * Specifies whether the table has banded rows. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedRows?: boolean; + lockAspectRatio?: 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. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: boolean; + name?: boolean; /** - * Specifies whether the table has a first column with a special style. + * 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] */ - styleFirstColumn?: boolean; + relativeHorizontalPosition?: boolean; /** - * Specifies whether the table has a last column with a special style. + * 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] */ - styleLastColumn?: boolean; + relativeHorizontalSize?: boolean; /** - * Specifies whether the table has a total (last) row with a special style. + * 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] */ - styleTotalRow?: boolean; + relativeVerticalPosition?: boolean; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * 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] */ - values?: boolean; + relativeVerticalSize?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: boolean; + rotation?: boolean; /** - * Specifies the width of the table in points. + * 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] - */ - width?: boolean; - } - /** - * Represents the TableStyle object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - 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`). + * [Api set: WordApiDesktop 1.2] */ - $all?: boolean; + top?: boolean; /** - * Specifies the table's alignment against the page margin. + * 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: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - alignment?: boolean; + topRelative?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Gets the shape type. 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] */ - allowBreakAcrossPage?: boolean; + type?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - bottomCellMargin?: boolean; + visible?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - cellSpacing?: boolean; + width?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * 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.6] + * [Api set: WordApiDesktop 1.2] */ - leftCellMargin?: boolean; + widthRelative?: boolean; + } + /** + * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface ShapeGroupLoadOptions { /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + 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 Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - rightCellMargin?: boolean; + shape?: Word.Interfaces.ShapeLoadOptions; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - topCellMargin?: boolean; + id?: boolean; } /** - * Contains the collection of the document's Table objects. + * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface TableCollectionLoadOptions { + interface CanvasLoadOptions { /** 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. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontLoadOptions; + shape?: Word.Interfaces.ShapeLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the table. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + id?: boolean; + } + /** + * 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: WordApiDesktop 1.2] + */ + interface ShapeCollectionLoadOptions { /** - * 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. + 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 shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * 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}. + * For EACH ITEM in the collection: 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] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + canvas?: Word.Interfaces.CanvasLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTable?: Word.Interfaces.TableLoadOptions; + fill?: Word.Interfaces.ShapeFillLoadOptions; /** - * 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. + * For EACH ITEM in the collection: 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + parentCanvas?: Word.Interfaces.ShapeLoadOptions; /** - * 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}. + * For EACH ITEM in the collection: 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + parentGroup?: Word.Interfaces.ShapeLoadOptions; /** - * 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}. + * For EACH ITEM in the collection: 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; /** - * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - alignment?: boolean; + textFrame?: Word.Interfaces.TextFrameLoadOptions; /** - * For EACH ITEM in the collection: Specifies the number of header rows. + * For EACH ITEM in the collection: Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - headerRowCount?: boolean; + textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** - * 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'. + * For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: boolean; + allowOverlap?: boolean; /** - * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. + * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isUniform?: boolean; + altTextDescription?: boolean; /** - * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. + * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - nestingLevel?: boolean; + geometricShapeType?: boolean; /** - * For EACH ITEM in the collection: Gets the number of rows in the table. + * For EACH ITEM in the collection: The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowCount?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * For EACH ITEM in the collection: 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] */ - shadingColor?: boolean; + heightRelative?: boolean; + /** + * For EACH ITEM in the collection: Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: 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. + * For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - style?: boolean; + isChild?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has banded columns. + * For EACH ITEM in the collection: 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] */ - styleBandedColumns?: boolean; + left?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has banded rows. + * For EACH ITEM in the collection: 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] */ - styleBandedRows?: boolean; + leftRelative?: 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. + * For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: boolean; + lockAspectRatio?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. + * For EACH ITEM in the collection: The name of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleFirstColumn?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. + * For EACH ITEM in the collection: 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] */ - styleLastColumn?: boolean; + relativeHorizontalPosition?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. + * For EACH ITEM in the collection: 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] */ - styleTotalRow?: boolean; + relativeHorizontalSize?: boolean; /** - * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. + * For EACH ITEM in the collection: 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?: boolean; + relativeVerticalPosition?: 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'. + * For EACH ITEM in the collection: 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?: boolean; + relativeVerticalSize?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the table in points. + * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.3] - */ - width?: boolean; - } - /** - * Represents a row in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - 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`). + * [Api set: WordApiDesktop 1.2] */ - $all?: boolean; + rotation?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * For EACH ITEM in the collection: 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] */ - font?: Word.Interfaces.FontLoadOptions; + top?: boolean; /** - * Gets parent table. + * For EACH ITEM in the collection: 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] */ - parentTable?: Word.Interfaces.TableLoadOptions; + topRelative?: boolean; /** - * Gets the number of cells in the row. + * For EACH ITEM in the collection: 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] */ - cellCount?: boolean; + type?: boolean; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * For EACH ITEM in the collection: Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: boolean; + visible?: boolean; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * For EACH ITEM in the collection: The width, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isHeader?: boolean; + width?: boolean; /** - * Specifies the preferred height of the row in points. + * For EACH ITEM in the collection: 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] */ - preferredHeight?: boolean; + widthRelative?: boolean; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface ShapeFillLoadOptions { /** - * Gets the index of the row in its parent table. + 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 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] */ - rowIndex?: boolean; + backgroundColor?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * 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] */ - shadingColor?: boolean; + foregroundColor?: boolean; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - values?: boolean; + transparency?: boolean; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: boolean; + type?: boolean; } /** - * Contains the collection of the document's TableRow objects. + * Represents the text frame of a shape object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface TableRowCollectionLoadOptions { + interface TextFrameLoadOptions { /** 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. + * 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontLoadOptions; + autoSizeSetting?: boolean; /** - * For EACH ITEM in the collection: Gets parent table. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTable?: Word.Interfaces.TableLoadOptions; + bottomMargin?: boolean; /** - * For EACH ITEM in the collection: Gets the number of cells in the row. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - cellCount?: boolean; + hasText?: 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'. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: boolean; + leftMargin?: 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. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isHeader?: boolean; + noTextRotation?: boolean; /** - * For EACH ITEM in the collection: Specifies the preferred height of the row in points. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - preferredHeight?: boolean; + orientation?: boolean; /** - * For EACH ITEM in the collection: Gets the index of the row in its parent table. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowIndex?: boolean; + rightMargin?: boolean; /** - * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: boolean; + topMargin?: boolean; /** - * For EACH ITEM in the collection: Specifies the text values in the row, as a 2D JavaScript array. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - values?: boolean; + verticalAlignment?: 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'. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: boolean; + wordWrap?: boolean; } /** - * Represents a table cell in a Word document. + * Represents all the properties for wrapping text around a shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface TableCellLoadOptions { + interface ShapeTextWrapLoadOptions { /** 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. + * 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyLoadOptions; + bottomDistance?: boolean; /** - * Gets the parent row of the cell. + * 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 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentRow?: Word.Interfaces.TableRowLoadOptions; + leftDistance?: boolean; /** - * Gets the parent table of the cell. + * 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.3] + * [Api set: WordApiDesktop 1.2] */ - parentTable?: Word.Interfaces.TableLoadOptions; + rightDistance?: boolean; /** - * Gets the index of the cell in its row. + * 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.3] + * [Api set: WordApiDesktop 1.2] */ - cellIndex?: boolean; + side?: boolean; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * 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.3] + * [Api set: WordApiDesktop 1.2] */ - columnWidth?: boolean; + topDistance?: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: boolean; + type?: boolean; + } + /** + * Represents a single item in a {@link Word.RepeatingSectionControlControl}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface RepeatingSectionItemLoadOptions { /** - * Gets the index of the cell's row in the table. - * - * @remarks - * [Api set: WordApi 1.3] + 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`). */ - rowIndex?: boolean; + $all?: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: boolean; + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Represents the `DatePickerContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DatePickerContentControlLoadOptions { /** - * Specifies the text of the cell. - * - * @remarks - * [Api set: WordApi 1.3] + 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`). */ - value?: boolean; + $all?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * 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 */ - verticalAlignment?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets the width of the cell in points. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] - */ - width?: boolean; - } - /** - * Contains the collection of the document's TableCell objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the body object of the cell. + * 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.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent row of the cell. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentRow?: Word.Interfaces.TableRowLoadOptions; + appearance?: boolean; /** - * For EACH ITEM in the collection: Gets the parent table of the cell. + * 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 */ - parentTable?: Word.Interfaces.TableLoadOptions; + color?: boolean; /** - * For EACH ITEM in the collection: Gets the index of the cell in its row. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellIndex?: boolean; + dateCalendarType?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies the format in which dates are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth?: boolean; + dateDisplayFormat?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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 */ - horizontalAlignment?: boolean; + dateDisplayLocale?: boolean; /** - * For EACH ITEM in the collection: Gets the index of the cell's row in the table. + * 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 */ - rowIndex?: boolean; + dateStorageFormat?: 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. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Specifies the text of the cell. + * 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 */ - value?: boolean; + isTemporary?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * 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.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: boolean; + level?: boolean; /** - * For EACH ITEM in the collection: Gets the width of the cell in points. + * 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 */ - width?: boolean; - } - /** - * Specifies the border style. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface TableBorderLoadOptions { + lockContentControl?: 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 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 */ - $all?: boolean; + lockContents?: boolean; /** - * Specifies the table border color. + * Gets whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies the type of the table border. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + tag?: boolean; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + title?: boolean; } /** - * Represents a tracked change in a Word document. + * Represents the `PictureContentControl` object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface TrackedChangeLoadOptions { + 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; /** - * Gets the author of the tracked change. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets the date of the tracked change. + * 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 */ - date?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the text of the tracked change. + * 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.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Gets the type of the tracked change. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] - */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.TrackedChange} objects. - * - * @remarks - * [Api set: WordApi 1.6] - */ - 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + appearance?: boolean; /** - * For EACH ITEM in the collection: Gets the author of the tracked change. + * 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 */ - author?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Gets the date of the tracked change. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - date?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the tracked change. + * 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 */ - text?: boolean; + isTemporary?: boolean; /** - * For EACH ITEM in the collection: Gets the type of the tracked change. + * 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] - */ - type?: boolean; - } - /** - * 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: WordApiDesktop 1.2] - */ - interface ShapeLoadOptions { - /** - 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; + level?: boolean; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * 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 */ - body?: Word.Interfaces.BodyLoadOptions; + lockContentControl?: 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 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 */ - canvas?: Word.Interfaces.CanvasLoadOptions; + lockContents?: boolean; /** - * Returns the fill formatting of the shape. + * 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 */ - fill?: Word.Interfaces.ShapeFillLoadOptions; + showingPlaceholderText?: boolean; /** - * 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 a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeLoadOptions; + tag?: 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 title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [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`). */ - parentGroup?: Word.Interfaces.ShapeLoadOptions; + $all?: boolean; /** - * 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 `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets the text frame object of the shape. + * 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 */ - textFrame?: Word.Interfaces.TextFrameLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the text wrap formatting of the shape. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Specifies whether a given shape can overlap other shapes. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + appearance?: boolean; /** - * Specifies a string that represents the alternative text associated with the 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 */ - altTextDescription?: boolean; + color?: boolean; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: boolean; + id?: boolean; /** - * The height, in points, of the shape. + * 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 */ - height?: boolean; + isTemporary?: boolean; /** - * 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 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 */ - heightRelative?: boolean; + level?: boolean; /** - * Gets an integer that represents the shape identifier. + * 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 */ - id?: boolean; + lockContentControl?: boolean; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * 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 */ - isChild?: boolean; + lockContents?: 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. + * 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 */ - left?: boolean; + showingPlaceholderText?: 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. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: boolean; + tag?: boolean; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + title?: boolean; + } + /** + * Represents the `BuildingBlockGalleryContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockGalleryContentControlLoadOptions { /** - * The name of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + 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`). */ - name?: boolean; + $all?: boolean; /** - * 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?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * 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 */ - relativeHorizontalSize?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * 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?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * 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 the appearance of the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: boolean; + appearance?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: boolean; + buildingBlockCategory?: 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 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 */ - top?: boolean; + buildingBlockType?: boolean; /** - * 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 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 */ - topRelative?: boolean; + color?: boolean; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + id?: boolean; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * 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 */ - visible?: boolean; + isTemporary?: boolean; /** - * The width, in points, of the shape. + * 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 */ - width?: boolean; + level?: 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 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] - */ - widthRelative?: boolean; - } - /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface ShapeGroupLoadOptions { - /** - 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; + lockContentControl?: boolean; /** - * Gets the Shape object associated with the group. + * 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 */ - shape?: Word.Interfaces.ShapeLoadOptions; + lockContents?: boolean; /** - * Gets an integer that represents the shape group identifier. + * Gets if the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - id?: boolean; - } - /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface CanvasLoadOptions { - /** - 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; + showingPlaceholderText?: boolean; /** - * Gets the Shape object associated with the canvas. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeLoadOptions; + tag?: boolean; /** - * Gets an integer that represents the canvas identifier. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + title?: boolean; } /** - * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Represents the `RepeatingSectionContentControl` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ShapeCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * 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 */ - body?: Word.Interfaces.BodyLoadOptions; + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * For EACH ITEM in the collection: 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}. + * 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 */ - canvas?: Word.Interfaces.CanvasLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns the fill formatting 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 */ - fill?: Word.Interfaces.ShapeFillLoadOptions; + xmlapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * For EACH ITEM in the collection: 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 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 */ - parentCanvas?: Word.Interfaces.ShapeLoadOptions; + allowInsertDeleteSection?: boolean; /** - * For EACH ITEM in the collection: 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 appearance of the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeLoadOptions; + appearance?: boolean; /** - * For EACH ITEM in the collection: 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 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 */ - shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; + color?: boolean; /** - * For EACH ITEM in the collection: Gets the text frame object of the shape. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameLoadOptions; + id?: boolean; /** - * For EACH ITEM in the collection: Returns the text wrap formatting of the shape. + * 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 */ - textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; + isTemporary?: boolean; /** - * For EACH ITEM in the collection: Specifies whether a given shape can overlap other 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 */ - allowOverlap?: boolean; + level?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with 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 */ - altTextDescription?: boolean; + lockContentControl?: boolean; /** - * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape. + * 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 */ - geometricShapeType?: boolean; + lockContents?: boolean; /** - * For EACH ITEM in the collection: The height, in points, of the shape. + * 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 */ - height?: boolean; + repeatingSectionItemTitle?: boolean; /** - * For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * 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 */ - heightRelative?: boolean; + showingPlaceholderText?: boolean; /** - * For EACH ITEM in the collection: Gets an integer that represents the shape identifier. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChild?: boolean; + title?: boolean; + } + /** + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface FrameLoadOptions { /** - * For EACH ITEM in the collection: 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: WordApiDesktop 1.2] + 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`). */ - left?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: 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. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: The name of the shape. + * Specifies the height (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: boolean; + heightRule?: boolean; /** - * For EACH ITEM in the collection: 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 the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: boolean; + horizontalDistanceFromText?: boolean; /** - * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: boolean; + horizontalPosition?: boolean; /** - * For EACH ITEM in the collection: 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 if the frame is locked. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: boolean; + lockAnchor?: boolean; /** - * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies the relative horizontal position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: boolean; + relativeHorizontalPosition?: boolean; /** - * For EACH ITEM in the collection: 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 relative vertical position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: boolean; + relativeVerticalPosition?: boolean; /** - * For EACH ITEM in the collection: 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 if document text wraps around the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: boolean; + textWrap?: boolean; /** - * For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + verticalDistanceFromText?: boolean; /** - * For EACH ITEM in the collection: Specifies if the shape is visible. Not applicable to inline shapes. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + verticalPosition?: boolean; /** - * For EACH ITEM in the collection: The width, in points, of the shape. + * Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ width?: boolean; /** - * For EACH ITEM in the collection: 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 rule used to determine the width of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: boolean; + widthRule?: boolean; } /** - * Represents the fill formatting of a shape object. + * Represents the collection of {@link Word.Frame} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ShapeFillLoadOptions { + interface FrameCollectionLoadOptions { /** 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 shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Specifies the height (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: boolean; + height?: boolean; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * For EACH ITEM in the collection: Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - type?: boolean; - } - /** - * Represents the text frame of a shape object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface TextFrameLoadOptions { - /** - 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; + heightRule?: 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. + * For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: boolean; + horizontalDistanceFromText?: boolean; /** - * Represents the bottom margin, in points, of the text frame. + * For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: boolean; + horizontalPosition?: boolean; /** - * Specifies if the text frame contains text. + * For EACH ITEM in the collection: Specifies if the frame is locked. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hasText?: boolean; + lockAnchor?: boolean; /** - * Represents the left margin, in points, of the text frame. + * For EACH ITEM in the collection: Specifies the relative horizontal position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: boolean; + relativeHorizontalPosition?: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * For EACH ITEM in the collection: Specifies the relative vertical position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + relativeVerticalPosition?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * For EACH ITEM in the collection: Specifies if document text wraps around the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: boolean; + textWrap?: boolean; /** - * Represents the right margin, in points, of the text frame. + * For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: boolean; + verticalDistanceFromText?: boolean; /** - * Represents the top margin, in points, of the text frame. + * For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: boolean; + verticalPosition?: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * For EACH ITEM in the collection: Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: boolean; + width?: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * For EACH ITEM in the collection: Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; + widthRule?: boolean; } /** - * Represents all the properties for wrapping text around a shape. + * Represents a document library version. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ShapeTextWrapLoadOptions { + interface DocumentLibraryVersionLoadOptions { /** 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 distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Gets any optional comments associated with this version of the shared document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: boolean; + comments?: boolean; /** - * 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 and time at which this version of the shared document was last saved to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: boolean; + modified?: boolean; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: boolean; + modifiedBy?: boolean; + } + /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentLibraryVersionCollectionLoadOptions { /** - * 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. + 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 any optional comments associated with this version of the shared document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: boolean; + comments?: boolean; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * For EACH ITEM in the collection: Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: boolean; + modified?: boolean; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * For EACH ITEM in the collection: Gets the name of the user who last saved this version of the shared document to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + modifiedBy?: boolean; } /** * Represents the list formatting characteristics of a range. @@ -137405,6 +149870,457 @@ declare namespace Word { */ z?: boolean; } + /** + * 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 + */ + interface BibliographyLoadOptions { + /** + 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 name of the active style to use for the bibliography. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliographyStyle?: boolean; + } + /** + * Represents a collection of {@link Word.Source} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SourceCollectionLoadOptions { + /** + 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 if the `Source` object has been cited in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isCited?: boolean; + /** + * For EACH ITEM in the collection: Gets the tag of the source. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * For EACH ITEM in the collection: Gets the XML representation of the source. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xml?: boolean; + } + /** + * Represents an individual source, such as a book, journal article, or interview. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SourceLoadOptions { + /** + 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 if the `Source` object has been cited in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isCited?: boolean; + /** + * Gets the tag of the source. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Gets the XML representation of the source. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xml?: boolean; + } + /** + * Represents the page setup settings for a Word document or section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface PageSetupLoadOptions { + /** + 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 `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; + /** + * Specifies whether Microsoft Word prints the document as a booklet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookFoldPrinting?: boolean; + /** + * Specifies the number of pages for each booklet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookFoldPrintingSheets?: boolean; + /** + * 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 + */ + bookFoldReversePrinting?: boolean; + /** + * 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 + */ + bottomMargin?: boolean; + /** + * Specifies the number of characters per line in the document grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + charsLine?: boolean; + /** + * Specifies whether the first page has a different header and footer. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + differentFirstPageHeaderFooter?: boolean; + /** + * Specifies the distance between the footer and the bottom of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footerDistance?: boolean; + /** + * 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 + */ + gutter?: boolean; + /** + * Specifies on which side the gutter appears in a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gutterPosition?: boolean; + /** + * 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 + */ + gutterStyle?: boolean; + /** + * Specifies the distance between the header and the top of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + headerDistance?: boolean; + /** + * Specifies the layout mode for the current document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + layoutMode?: boolean; + /** + * 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 + */ + leftMargin?: boolean; + /** + * Specifies the number of lines per page in the document grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linesPage?: boolean; + /** + * Specifies if the inside and outside margins of facing pages are the same width. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mirrorMargins?: boolean; + /** + * Specifies whether odd and even pages have different headers and footers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddAndEvenPagesHeaderFooter?: boolean; + /** + * Specifies the orientation of the page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + orientation?: boolean; + /** + * Specifies the page height in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageHeight?: boolean; + /** + * Specifies the page width in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageWidth?: boolean; + /** + * Specifies the paper size of the page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paperSize?: boolean; + /** + * 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 + */ + rightMargin?: boolean; + /** + * Specifies the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sectionDirection?: boolean; + /** + * Specifies the type of section break for the specified object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sectionStart?: boolean; + /** + * Specifies whether to show the grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showGrid?: boolean; + /** + * 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 + */ + suppressEndnotes?: boolean; + /** + * Specifies the top margin of the page in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topMargin?: boolean; + /** + * Specifies whether to print two pages per sheet. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + twoPagesOnOne?: boolean; + /** + * Specifies the vertical alignment of text on each page in a document or section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalAlignment?: boolean; + } + /** + * Represents line numbers in the left margin or to the left of each newspaper-style column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface LineNumberingLoadOptions { + /** + 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 numeric increment for line numbers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + countBy?: boolean; + /** + * 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?: boolean; + /** + * Specifies if line numbering is active for the specified document, section, or sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isActive?: 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartMode?: boolean; + /** + * Specifies the starting line number. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + startingNumber?: boolean; + } + /** + * 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 + */ + interface TextColumnCollectionLoadOptions { + /** + 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 amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spaceAfter?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width, in points, of the specified text columns. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: boolean; + } + /** + * Represents a single text column in a section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TextColumnLoadOptions { + /** + 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 spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spaceAfter?: boolean; + /** + * Specifies the width, in points, of the specified text columns. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: boolean; + } } } declare namespace Word { diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 6d51197d903ff2..1a60f14f71d4cb 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -92459,14 +92459,14 @@ 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 data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * 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 data of the content control when its type is 'ComboBox'. It's `null` otherwise. + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] @@ -92480,7 +92480,7 @@ declare namespace Word { */ readonly contentControls: Word.ContentControlCollection; /** - * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise. + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] @@ -92662,7 +92662,7 @@ declare namespace Word { * @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"; + 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. * @@ -92690,7 +92690,7 @@ declare namespace Word { * @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"; + 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. @@ -102429,6 +102429,11 @@ declare namespace Word { * [Api set: WordApi 1.1] */ plainText = "PlainText", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + group = "Group", } /** * ContentControl appearance. @@ -107407,7 +107412,7 @@ declare namespace Word { /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ interface ContentControlUpdateData { /** - * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.7] @@ -109407,14 +109412,14 @@ declare namespace Word { /** An interface describing the data returned by calling `contentControl.toJSON()`. */ interface ContentControlData { /** - * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * 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 data of the content control when its type is 'ComboBox'. It's `null` otherwise. + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] @@ -109428,7 +109433,7 @@ declare namespace Word { */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise. + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] @@ -109547,7 +109552,7 @@ declare namespace Word { * @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"; + 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. * @@ -109575,7 +109580,7 @@ declare namespace Word { * @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"; + 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 { @@ -112396,7 +112401,7 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.7] @@ -112569,7 +112574,7 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise. + * 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]