Word.Interfaces.StyleData interface

Specifies whether the style is automatically redefined based on the selection.

automaticallyUpdate?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the name of an existing style to use as the base formatting of another style.

baseStyle?: string;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Note: The ability to set baseStyle was introduced in WordApi 1.6.

Specifies a BorderCollection object that represents all the borders for the style.

borders?: Word.Interfaces.BorderData[];

Property Value

Remarks

[ API set: WordApiDesktop 1.1 ]

Gets whether the style is a built-in style.

builtIn?: boolean;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Gets a Font object that represents the character formatting of the style.

font?: Word.Interfaces.FontData;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Returns a Frame object that represents the frame formatting for the style.

frame?: Word.Interfaces.FrameData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies whether the spelling and grammar checker ignores text formatted with this style.

hasProofing?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets whether the 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.

inUse?: boolean;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Specifies a LanguageId value that represents the language for the style.

languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies an East Asian language for the style.

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";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets whether the style is a linked style that can be used for both paragraph and character formatting.

linked?: boolean;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Specifies a link between a paragraph and a character style.

linkStyle?: Word.Interfaces.StyleData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Returns the list level for the style.

listLevelNumber?: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets a ListTemplate object that represents the list formatting for the style.

listTemplate?: Word.Interfaces.ListTemplateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.1 ]

Specifies whether the style cannot be changed or edited.

locked?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets the name of the style in the language of the user.

nameLocal?: string;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style.

nextParagraphStyle?: string;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Note: The ability to set nextParagraphStyle was introduced in WordApi 1.6.

Specifies whether to remove spacing between paragraphs that are formatted using the same style.

noSpaceBetweenParagraphsOfSameStyle?: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets a ParagraphFormat object that represents the paragraph settings for the style.

paragraphFormat?: Word.Interfaces.ParagraphFormatData;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Specifies the priority.

priority?: number;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Specifies whether the style corresponds to an available quick style.

quickStyle?: boolean;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Gets a Shading object that represents the shading for the style. Not applicable to a style of List type.

shading?: Word.Interfaces.ShadingData;

Property Value

Remarks

[ API set: WordApi 1.6 ]

Gets a TableStyle object representing style properties that can be applied to a table.

tableStyle?: Word.Interfaces.TableStyleData;

Property Value

Remarks

[ API set: WordApi 1.6 ]

Gets the style type.

type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table";

Property Value

Remarks

[ API set: WordApi 1.5 ]

Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document.

unhideWhenUsed?: boolean;

Property Value

Remarks

[ API set: WordApi 1.5 ]

Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane.

visibility?: boolean;

Property Value

Remarks

[ API set: WordApi 1.5 ]