NumberStyle (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.NumberStyle

public class NumberStyle
extends java.lang.Object

Specifies the number style for a list, footnotes and endnotes, page numbers.

Examples:

Shows how to apply custom list formatting to paragraphs when using DocumentBuilder.

 
 Document doc = new Document();

 // A list allows us to organize and decorate sets of paragraphs with prefix symbols and indents.
 // We can create nested lists by increasing the indent level.
 // We can begin and end a list by using a document builder's "ListFormat" property.
 // Each paragraph that we add between a list's start and the end will become an item in the list.
 // Create a list from a Microsoft Word template, and customize the first two of its list levels.
 List docList = doc.getLists().add(ListTemplate.NUMBER_DEFAULT);

 ListLevel listLevel = docList.getListLevels().get(0);
 listLevel.getFont().setColor(Color.RED);
 listLevel.getFont().setSize(24.0);
 listLevel.setNumberStyle(NumberStyle.ORDINAL_TEXT);
 listLevel.setStartAt(21);
 listLevel.setNumberFormat("");

 listLevel.setNumberPosition(-36);
 listLevel.setTextPosition(144.0);
 listLevel.setTabPosition(144.0);

 listLevel = docList.getListLevels().get(1);
 listLevel.setAlignment(ListLevelAlignment.RIGHT);
 listLevel.setNumberStyle(NumberStyle.BULLET);
 listLevel.getFont().setName("Wingdings");
 listLevel.getFont().setColor(Color.BLUE);
 listLevel.getFont().setSize(24.0);

 // This NumberFormat value will create star-shaped bullet list symbols.
 listLevel.setNumberFormat("");
 listLevel.setTrailingCharacter(ListTrailingCharacter.SPACE);
 listLevel.setNumberPosition(144.0);

 // Create paragraphs and apply both list levels of our custom list formatting to them.
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.getListFormat().setList(docList);
 builder.writeln("The quick brown fox...");
 builder.writeln("The quick brown fox...");

 builder.getListFormat().listIndent();
 builder.writeln("jumped over the lazy dog.");
 builder.writeln("jumped over the lazy dog.");

 builder.getListFormat().listOutdent();
 builder.writeln("The quick brown fox...");

 builder.getListFormat().removeNumbers();

 builder.getDocument().save(getArtifactsDir() + "Lists.CreateCustomList.docx");

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AIUEO` Aiueo full width
`static int`	`AIUEO_HALF_WIDTH` Aiueo
`static int`	`ARABIC` Arabic numbering (1, 2, 3, ...)
`static int`	`ARABIC_1` Arabic alpha
`static int`	`ARABIC_2` Arabic abjad
`static int`	`ARABIC_FULL_WIDTH` Full-width Arabic: 1, 2, 3, 4
`static int`	`ARABIC_HALF_WIDTH` Half-width Arabic: 1, 2, 3, 4
`static int`	`BULLET` Bullet (check the character code in the text)
`static int`	`CHICAGO_MANUAL` Chicago Manual of Style: *, †, †
`static int`	`CHOSUNG` Korea Chosung
`static int`	`CUSTOM` Custom number format.
`static int`	`DECIMAL_FULL_WIDTH` Decimal full width: 1, 2, 3, 4
`static int`	`GANADA` Korean Ganada
`static int`	`GB_1` Enclosed full stop
`static int`	`GB_2` Enclosed parenthesis
`static int`	`GB_3` Enclosed circle Chinese
`static int`	`GB_4` Ideograph enclosed circle
`static int`	`HANGUL` Korea legal
`static int`	`HANJA` Korea digital2
`static int`	`HANJA_READ` Korean digital
`static int`	`HANJA_READ_DIGIT` Korean counting
`static int`	`HEBREW_1` Hebrew-1
`static int`	`HEBREW_2` Hebrew-2
`static int`	`HEX` Hexadecimal: 8, 9, A, B, C, D, E, F, 10, 11, 12
`static int`	`HINDI_ARABIC` Hindi numbers
`static int`	`HINDI_CARDINAL_TEXT` Hindi descriptive (cardinals)
`static int`	`HINDI_LETTER_1` Hindi vowels
`static int`	`HINDI_LETTER_2` Hindi consonants
`static int`	`IROHA` Iroha full width
`static int`	`IROHA_HALF_WIDTH` Iroha
`static int`	`KANJI` Ideograph-digital
`static int`	`KANJI_DIGIT` Japanese counting
`static int`	`KANJI_TRADITIONAL` Japanese legal
`static int`	`KANJI_TRADITIONAL_2` Japanese digital ten thousand
`static int`	`LEADING_ZERO` Leading Zero (01, 02,..., 09, 10, 11,..., 99, 100, 101,...)
`static int`	`length`
`static int`	`LOWERCASE_LETTER` Lower case letter (a, b, c, ...)
`static int`	`LOWERCASE_ROMAN` Lower case Roman (i, ii, iii, ...)
`static int`	`LOWERCASE_RUSSIAN` Lowercase Russian alphabet
`static int`	`NONE` No bullet or number.
`static int`	`NUMBER` Numbered (One, Two, Three, ...)
`static int`	`NUMBER_IN_CIRCLE` Enclosed circles
`static int`	`NUMBER_IN_DASH` Page number format: - 1 -, - 2 -, - 3 -, - 4 -
`static int`	`ORDINAL` Ordinal (1st, 2nd, 3rd, ...)
`static int`	`ORDINAL_TEXT` Ordinal (text) (First, Second, Third, ...)
`static int`	`SIMP_CHIN_NUM_1` Chinese counting
`static int`	`SIMP_CHIN_NUM_2` Chinese legal simplified
`static int`	`SIMP_CHIN_NUM_3` Chinese counting thousand
`static int`	`SIMP_CHIN_NUM_4` Chinese (not implemented)
`static int`	`THAI_ARABIC` Thai numbers
`static int`	`THAI_CARDINAL_TEXT` Thai descriptive (cardinals)
`static int`	`THAI_LETTER` Thai letters
`static int`	`TRAD_CHIN_NUM_1` Taiwanese counting
`static int`	`TRAD_CHIN_NUM_2` Ideograph legal traditional
`static int`	`TRAD_CHIN_NUM_3` Taiwanese counting thousand
`static int`	`TRAD_CHIN_NUM_4` Taiwanese digital
`static int`	`UPPERCASE_LETTER` Upper case Letter (A, B, C, ...)
`static int`	`UPPERCASE_ROMAN` Upper case Roman (I, II, III, ...)
`static int`	`UPPERCASE_RUSSIAN` Uppercase Russian alphabet
`static int`	`VIET_CARDINAL_TEXT` Vietnamese descriptive (cardinals)
`static int`	`ZODIAC_1` Ideograph traditional
`static int`	`ZODIAC_2` Ideograph Zodiac
`static int`	`ZODIAC_3` Ideograph Zodiac traditional

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`fromName(java.lang.String numberStyleName)`
`static java.lang.String`	`getName(int numberStyle)`
`static int[]`	`getValues()`
`static java.lang.String`	`toString(int numberStyle)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ARABIC
```
public static int ARABIC
```
    Arabic numbering (1, 2, 3, ...)
  - UPPERCASE_ROMAN
```
public static int UPPERCASE_ROMAN
```
    Upper case Roman (I, II, III, ...)
  - LOWERCASE_ROMAN
```
public static int LOWERCASE_ROMAN
```
    Lower case Roman (i, ii, iii, ...)
  - UPPERCASE_LETTER
```
public static int UPPERCASE_LETTER
```
    Upper case Letter (A, B, C, ...)
  - LOWERCASE_LETTER
```
public static int LOWERCASE_LETTER
```
    Lower case letter (a, b, c, ...)
  - ORDINAL
```
public static int ORDINAL
```
    Ordinal (1st, 2nd, 3rd, ...)
  - NUMBER
```
public static int NUMBER
```
    Numbered (One, Two, Three, ...)
  - ORDINAL_TEXT
```
public static int ORDINAL_TEXT
```
    Ordinal (text) (First, Second, Third, ...)
  - HEX
```
public static int HEX
```
    Hexadecimal: 8, 9, A, B, C, D, E, F, 10, 11, 12
  - CHICAGO_MANUAL
```
public static int CHICAGO_MANUAL
```
    Chicago Manual of Style: *, †, †
  - KANJI
```
public static int KANJI
```
    Ideograph-digital
  - KANJI_DIGIT
```
public static int KANJI_DIGIT
```
    Japanese counting
  - AIUEO_HALF_WIDTH
```
public static int AIUEO_HALF_WIDTH
```
    Aiueo
  - IROHA_HALF_WIDTH
```
public static int IROHA_HALF_WIDTH
```
    Iroha
  - ARABIC_FULL_WIDTH
```
public static int ARABIC_FULL_WIDTH
```
    Full-width Arabic: 1, 2, 3, 4
  - ARABIC_HALF_WIDTH
```
public static int ARABIC_HALF_WIDTH
```
    Half-width Arabic: 1, 2, 3, 4
  - KANJI_TRADITIONAL
```
public static int KANJI_TRADITIONAL
```
    Japanese legal
  - KANJI_TRADITIONAL_2
```
public static int KANJI_TRADITIONAL_2
```
    Japanese digital ten thousand
  - NUMBER_IN_CIRCLE
```
public static int NUMBER_IN_CIRCLE
```
    Enclosed circles
  - DECIMAL_FULL_WIDTH
```
public static int DECIMAL_FULL_WIDTH
```
    Decimal full width: 1, 2, 3, 4
  - AIUEO
```
public static int AIUEO
```
    Aiueo full width
  - IROHA
```
public static int IROHA
```
    Iroha full width
  - LEADING_ZERO
```
public static int LEADING_ZERO
```
    Leading Zero (01, 02,..., 09, 10, 11,..., 99, 100, 101,...)
  - BULLET
```
public static int BULLET
```
    Bullet (check the character code in the text)
  - GANADA
```
public static int GANADA
```
    Korean Ganada
  - CHOSUNG
```
public static int CHOSUNG
```
    Korea Chosung
  - GB_1
```
public static int GB_1
```
    Enclosed full stop
  - GB_2
```
public static int GB_2
```
    Enclosed parenthesis
  - GB_3
```
public static int GB_3
```
    Enclosed circle Chinese
  - GB_4
```
public static int GB_4
```
    Ideograph enclosed circle
  - ZODIAC_1
```
public static int ZODIAC_1
```
    Ideograph traditional
  - ZODIAC_2
```
public static int ZODIAC_2
```
    Ideograph Zodiac
  - ZODIAC_3
```
public static int ZODIAC_3
```
    Ideograph Zodiac traditional
  - TRAD_CHIN_NUM_1
```
public static int TRAD_CHIN_NUM_1
```
    Taiwanese counting
  - TRAD_CHIN_NUM_2
```
public static int TRAD_CHIN_NUM_2
```
    Ideograph legal traditional
  - TRAD_CHIN_NUM_3
```
public static int TRAD_CHIN_NUM_3
```
    Taiwanese counting thousand
  - TRAD_CHIN_NUM_4
```
public static int TRAD_CHIN_NUM_4
```
    Taiwanese digital
  - SIMP_CHIN_NUM_1
```
public static int SIMP_CHIN_NUM_1
```
    Chinese counting
  - SIMP_CHIN_NUM_2
```
public static int SIMP_CHIN_NUM_2
```
    Chinese legal simplified
  - SIMP_CHIN_NUM_3
```
public static int SIMP_CHIN_NUM_3
```
    Chinese counting thousand
  - SIMP_CHIN_NUM_4
```
public static int SIMP_CHIN_NUM_4
```
    Chinese (not implemented)
  - HANJA_READ
```
public static int HANJA_READ
```
    Korean digital
  - HANJA_READ_DIGIT
```
public static int HANJA_READ_DIGIT
```
    Korean counting
  - HANGUL
```
public static int HANGUL
```
    Korea legal
  - HANJA
```
public static int HANJA
```
    Korea digital2
  - HEBREW_1
```
public static int HEBREW_1
```
    Hebrew-1
  - ARABIC_1
```
public static int ARABIC_1
```
    Arabic alpha
  - HEBREW_2
```
public static int HEBREW_2
```
    Hebrew-2
  - ARABIC_2
```
public static int ARABIC_2
```
    Arabic abjad
  - HINDI_LETTER_1
```
public static int HINDI_LETTER_1
```
    Hindi vowels
  - HINDI_LETTER_2
```
public static int HINDI_LETTER_2
```
    Hindi consonants
  - HINDI_ARABIC
```
public static int HINDI_ARABIC
```
    Hindi numbers
  - HINDI_CARDINAL_TEXT
```
public static int HINDI_CARDINAL_TEXT
```
    Hindi descriptive (cardinals)
  - THAI_LETTER
```
public static int THAI_LETTER
```
    Thai letters
  - THAI_ARABIC
```
public static int THAI_ARABIC
```
    Thai numbers
  - THAI_CARDINAL_TEXT
```
public static int THAI_CARDINAL_TEXT
```
    Thai descriptive (cardinals)
  - VIET_CARDINAL_TEXT
```
public static int VIET_CARDINAL_TEXT
```
    Vietnamese descriptive (cardinals)
  - NUMBER_IN_DASH
```
public static int NUMBER_IN_DASH
```
    Page number format: - 1 -, - 2 -, - 3 -, - 4 -
  - LOWERCASE_RUSSIAN
```
public static int LOWERCASE_RUSSIAN
```
    Lowercase Russian alphabet
  - UPPERCASE_RUSSIAN
```
public static int UPPERCASE_RUSSIAN
```
    Uppercase Russian alphabet
  - NONE
```
public static int NONE
```
    No bullet or number.
  - CUSTOM
```
public static int CUSTOM
```
    Custom number format. It is supported by DOCX format only.
  - length
```
public static int length
```
- Method Detail
  - getName
```
public static java.lang.String getName(int numberStyle)
```
  - toString
```
public static java.lang.String toString(int numberStyle)
```
  - fromName
```
public static int fromName(java.lang.String numberStyleName)
```
  - getValues
```
public static int[] getValues()
```

Class NumberStyle

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ARABIC

UPPERCASE_ROMAN

LOWERCASE_ROMAN

UPPERCASE_LETTER

LOWERCASE_LETTER

ORDINAL

NUMBER

ORDINAL_TEXT

HEX

CHICAGO_MANUAL

KANJI

KANJI_DIGIT

AIUEO_HALF_WIDTH

IROHA_HALF_WIDTH

ARABIC_FULL_WIDTH

ARABIC_HALF_WIDTH

KANJI_TRADITIONAL

KANJI_TRADITIONAL_2

NUMBER_IN_CIRCLE

DECIMAL_FULL_WIDTH

AIUEO

IROHA

LEADING_ZERO

BULLET

GANADA

CHOSUNG

GB_1

GB_2

GB_3

GB_4

ZODIAC_1

ZODIAC_2

ZODIAC_3

TRAD_CHIN_NUM_1

TRAD_CHIN_NUM_2

TRAD_CHIN_NUM_3

TRAD_CHIN_NUM_4

SIMP_CHIN_NUM_1

SIMP_CHIN_NUM_2

SIMP_CHIN_NUM_3

SIMP_CHIN_NUM_4

HANJA_READ

HANJA_READ_DIGIT

HANGUL

HANJA

HEBREW_1

ARABIC_1

HEBREW_2

ARABIC_2

HINDI_LETTER_1

HINDI_LETTER_2

HINDI_ARABIC

HINDI_CARDINAL_TEXT

THAI_LETTER

THAI_ARABIC

THAI_CARDINAL_TEXT

VIET_CARDINAL_TEXT

NUMBER_IN_DASH

LOWERCASE_RUSSIAN

UPPERCASE_RUSSIAN

NONE

CUSTOM

length

Method Detail

getName

toString

fromName

getValues