Edit

Share via

Word.ListBuiltInNumberStyle enum

Package:
word

Represents the built-in number styles for lists in Word.

Remarks

[ API set: WordApiDesktop 1.1 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/manage-list-styles.yaml

// Gets the properties of the specified style.
await Word.run(async (context) => {
  const styleName = (document.getElementById("style-name-to-use") as HTMLInputElement).value;
  if (styleName == "") {
    console.warn("Enter a style name to get properties.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load("type");
  await context.sync();

  if (style.isNullObject || style.type != Word.StyleType.list) {
    console.warn(`There's no existing style with the name '${styleName}'. Or this isn't a list style.`);
  } else {
    // Load objects to log properties and their values in the console.
    style.load();
    style.listTemplate.load();
    await context.sync();

    console.log(`Properties of the '${styleName}' style:`, style);

    const listLevels = style.listTemplate.listLevels;
    listLevels.load("items");
    await context.sync();

    console.log(`List levels of the '${styleName}' style:`, listLevels);
  }
});

Fields

aiueo = "Aiueo"

Aiueo characters.
aiueoHalfWidth = "AiueoHalfWidth"

Aiueo half width characters.
arabic = "Arabic"

Arabic numerals (1, 2, 3, ...).
arabic1 = "Arabic1"

Arabic1 characters.
arabic2 = "Arabic2"

Arabic2 characters.
arabicFullWidth = "ArabicFullWidth"

Arabic full-width numbers.
arabicLZ = "ArabicLZ"

Arabic full-width numbers with leading zeros.
arabicLZ2 = "ArabicLZ2"

Arabic numbers with leading zeros (style 2).
arabicLZ3 = "ArabicLZ3"

Arabic numbers with leading zeros (style 3).
arabicLZ4 = "ArabicLZ4"

Arabic numbers with leading zeros (style 4).
bullet = "Bullet"

Bullet characters.
cardinalText = "CardinalText"

Cardinal numbers as text (one, two, three, ...).
chosung = "Chosung"

Chosung characters.
ganada = "Ganada"

Ganada characters.
gbnum1 = "GBNum1"

GBNum1 characters.
gbnum2 = "GBNum2"

GBNum2 characters.
gbnum3 = "GBNum3"

GBNum3 characters.
gbnum4 = "GBNum4"

GBNum4 characters.
hangul = "Hangul"

Hangul characters.
hanja = "Hanja"

Hanja characters.
hanjaRead = "HanjaRead"

Hanja read numbers.
hanjaReadDigit = "HanjaReadDigit"

Hanja read digits.
hebrew1 = "Hebrew1"

Hebrew1 characters.
hebrew2 = "Hebrew2"

Hebrew2 characters.
hindiArabic = "HindiArabic"

Hindi Arabic style.
hindiCardinalText = "HindiCardinalText"

Hindi cardinal text.
hindiLetter1 = "HindiLetter1"

Hindi letter style 1.
hindiLetter2 = "HindiLetter2"

Hindi letter style 2.
iroha = "Iroha"

Iroha characters.
irohaHalfWidth = "IrohaHalfWidth"

Iroha half width characters.
kanji = "Kanji"

Kanji.
kanjiDigit = "KanjiDigit"

Kanji digits.
kanjiTraditional = "KanjiTraditional"

Traditional Kanji characters.
kanjiTraditional2 = "KanjiTraditional2"

Traditional Kanji characters (alternative form).
legal = "Legal"

Legal numbering style.
legalLZ = "LegalLZ"

Legal numbering style with leading zeros.
lowercaseBulgarian = "LowercaseBulgarian"

Lowercase Bulgarian.
lowercaseGreek = "LowercaseGreek"

Lowercase Greek.
lowercaseRussian = "LowercaseRussian"

Lowercase Russian.
lowercaseTurkish = "LowercaseTurkish"

Lowercase Turkish.
lowerLetter = "LowerLetter"

Lowercase letters (a, b, c, ...).
lowerRoman = "LowerRoman"

Lowercase Roman numerals (i, ii, iii, ...).
none = "None"

No built-in number style.
numberInCircle = "NumberInCircle"

Numbers enclosed in a circle.
ordinal = "Ordinal"

Ordinal numbers (1st, 2nd, 3rd, ...).
ordinalText = "OrdinalText"

Ordinal numbers as text (first, second, third, ...).
pictureBullet = "PictureBullet"

Picture bullet.
simpChinNum1 = "SimpChinNum1"

Simplified Chinese numbers (style 1).
simpChinNum2 = "SimpChinNum2"

Simplified Chinese numbers (style 2).
simpChinNum3 = "SimpChinNum3"

Simplified Chinese numbers (style 3).
simpChinNum4 = "SimpChinNum4"

Simplified Chinese numbers (style 4).
thaiArabic = "ThaiArabic"

Thai Arabic characters.
thaiCardinalText = "ThaiCardinalText"

Thai cardinal text.
thaiLetter = "ThaiLetter"

Thai letter characters.
tradChinNum1 = "TradChinNum1"

Traditional Chinese numbers (style 1).
tradChinNum2 = "TradChinNum2"

Traditional Chinese numbers (style 2).
tradChinNum3 = "TradChinNum3"

Traditional Chinese numbers (style 3).
tradChinNum4 = "TradChinNum4"

Traditional Chinese numbers (style 4).
uppercaseBulgarian = "UppercaseBulgarian"

Uppercase Bulgarian.
uppercaseGreek = "UppercaseGreek"

Uppercase Greek.
uppercaseRussian = "UppercaseRussian"

Uppercase Russian.
uppercaseTurkish = "UppercaseTurkish"

Uppercase Turkish.
upperLetter = "UpperLetter"

Uppercase letters (A, B, C, ...).
upperRoman = "UpperRoman"

Uppercase Roman numerals (I, II, III, ...).
vietCardinalText = "VietCardinalText"

Vietnamese cardinal text.
zodiac1 = "Zodiac1"

Zodiac1 characters.
zodiac2 = "Zodiac2"

Zodiac2 characters.
zodiac3 = "Zodiac3"

Zodiac3 characters.