com.aspose.words
Class NumberStyle

java.lang.Object
    extended by com.aspose.words.NumberStyle

public class NumberStyle 
extends java.lang.Object

Utility class containing constants. Specifies the number style for a list, footnotes and endnotes, page numbers.

Example:

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 list = doc.getLists().add(ListTemplate.NUMBER_DEFAULT);

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

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

listLevel = list.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("\uf0af");
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(list);
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
static final intARABIC = 0
           Arabic numbering (1, 2, 3, ...)
static final intUPPERCASE_ROMAN = 1
           Upper case Roman (I, II, III, ...)
static final intLOWERCASE_ROMAN = 2
           Lower case Roman (i, ii, iii, ...)
static final intUPPERCASE_LETTER = 3
           Upper case Letter (A, B, C, ...)
static final intLOWERCASE_LETTER = 4
           Lower case letter (a, b, c, ...)
static final intORDINAL = 5
           Ordinal (1st, 2nd, 3rd, ...)
static final intNUMBER = 6
           Numbered (One, Two, Three, ...)
static final intORDINAL_TEXT = 7
           Ordinal (text) (First, Second, Third, ...)
static final intHEX = 8
           Hexadecimal: 8, 9, A, B, C, D, E, F, 10, 11, 12
static final intCHICAGO_MANUAL = 9
           Chicago Manual of Style: *, †, †
static final intKANJI = 10
           Ideograph-digital
static final intKANJI_DIGIT = 11
           Japanese counting
static final intAIUEO_HALF_WIDTH = 12
           Aiueo
static final intIROHA_HALF_WIDTH = 13
           Iroha
static final intARABIC_FULL_WIDTH = 14
           Full-width Arabic: 1, 2, 3, 4
static final intARABIC_HALF_WIDTH = 15
           Half-width Arabic: 1, 2, 3, 4
static final intKANJI_TRADITIONAL = 16
           Japanese legal
static final intKANJI_TRADITIONAL_2 = 17
           Japanese digital ten thousand
static final intNUMBER_IN_CIRCLE = 18
           Enclosed circles
static final intDECIMAL_FULL_WIDTH = 19
           Decimal full width: 1, 2, 3, 4
static final intAIUEO = 20
           Aiueo full width
static final intIROHA = 21
           Iroha full width
static final intLEADING_ZERO = 22
           Leading Zero (01, 02,..., 09, 10, 11,..., 99, 100, 101,...)
static final intBULLET = 23
           Bullet (check the character code in the text)
static final intGANADA = 24
           Korean Ganada
static final intCHOSUNG = 25
           Korea Chosung
static final intGB_1 = 26
           Enclosed full stop
static final intGB_2 = 27
           Enclosed parenthesis
static final intGB_3 = 28
           Enclosed circle Chinese
static final intGB_4 = 29
           Ideograph enclosed circle
static final intZODIAC_1 = 30
           Ideograph traditional
static final intZODIAC_2 = 31
           Ideograph Zodiac
static final intZODIAC_3 = 32
           Ideograph Zodiac traditional
static final intTRAD_CHIN_NUM_1 = 33
           Taiwanese counting
static final intTRAD_CHIN_NUM_2 = 34
           Ideograph legal traditional
static final intTRAD_CHIN_NUM_3 = 35
           Taiwanese counting thousand
static final intTRAD_CHIN_NUM_4 = 36
           Taiwanese digital
static final intSIMP_CHIN_NUM_1 = 37
           Chinese counting
static final intSIMP_CHIN_NUM_2 = 38
           Chinese legal simplified
static final intSIMP_CHIN_NUM_3 = 39
           Chinese counting thousand
static final intSIMP_CHIN_NUM_4 = 40
           Chinese (not implemented)
static final intHANJA_READ = 41
           Korean digital
static final intHANJA_READ_DIGIT = 42
           Korean counting
static final intHANGUL = 43
           Korea legal
static final intHANJA = 44
           Korea digital2
static final intHEBREW_1 = 45
           Hebrew-1
static final intARABIC_1 = 46
           Arabic alpha
static final intHEBREW_2 = 47
           Hebrew-2
static final intARABIC_2 = 48
           Arabic abjad
static final intHINDI_LETTER_1 = 49
           Hindi vowels
static final intHINDI_LETTER_2 = 50
           Hindi consonants
static final intHINDI_ARABIC = 51
           Hindi numbers
static final intHINDI_CARDINAL_TEXT = 52
           Hindi descriptive (cardinals)
static final intTHAI_LETTER = 53
           Thai letters
static final intTHAI_ARABIC = 54
           Thai numbers
static final intTHAI_CARDINAL_TEXT = 55
           Thai descriptive (cardinals)
static final intVIET_CARDINAL_TEXT = 56
           Vietnamese descriptive (cardinals)
static final intNUMBER_IN_DASH = 57
           Page number format: - 1 -, - 2 -, - 3 -, - 4 -
static final intLOWERCASE_RUSSIAN = 58
           Lowercase Russian alphabet
static final intUPPERCASE_RUSSIAN = 59
           Uppercase Russian alphabet
static final intNONE = 255
           No bullet or number.
static final intCUSTOM = 65280
           Custom number format. It is supported by DOCX format only.
 

Field Detail

ARABIC = 0

public static final int ARABIC
Arabic numbering (1, 2, 3, ...)

UPPERCASE_ROMAN = 1

public static final int UPPERCASE_ROMAN
Upper case Roman (I, II, III, ...)

LOWERCASE_ROMAN = 2

public static final int LOWERCASE_ROMAN
Lower case Roman (i, ii, iii, ...)

UPPERCASE_LETTER = 3

public static final int UPPERCASE_LETTER
Upper case Letter (A, B, C, ...)

LOWERCASE_LETTER = 4

public static final int LOWERCASE_LETTER
Lower case letter (a, b, c, ...)

ORDINAL = 5

public static final int ORDINAL
Ordinal (1st, 2nd, 3rd, ...)

NUMBER = 6

public static final int NUMBER
Numbered (One, Two, Three, ...)

ORDINAL_TEXT = 7

public static final int ORDINAL_TEXT
Ordinal (text) (First, Second, Third, ...)

HEX = 8

public static final int HEX
Hexadecimal: 8, 9, A, B, C, D, E, F, 10, 11, 12

CHICAGO_MANUAL = 9

public static final int CHICAGO_MANUAL
Chicago Manual of Style: *, †, †

KANJI = 10

public static final int KANJI
Ideograph-digital

KANJI_DIGIT = 11

public static final int KANJI_DIGIT
Japanese counting

AIUEO_HALF_WIDTH = 12

public static final int AIUEO_HALF_WIDTH
Aiueo

IROHA_HALF_WIDTH = 13

public static final int IROHA_HALF_WIDTH
Iroha

ARABIC_FULL_WIDTH = 14

public static final int ARABIC_FULL_WIDTH
Full-width Arabic: 1, 2, 3, 4

ARABIC_HALF_WIDTH = 15

public static final int ARABIC_HALF_WIDTH
Half-width Arabic: 1, 2, 3, 4

KANJI_TRADITIONAL = 16

public static final int KANJI_TRADITIONAL
Japanese legal

KANJI_TRADITIONAL_2 = 17

public static final int KANJI_TRADITIONAL_2
Japanese digital ten thousand

NUMBER_IN_CIRCLE = 18

public static final int NUMBER_IN_CIRCLE
Enclosed circles

DECIMAL_FULL_WIDTH = 19

public static final int DECIMAL_FULL_WIDTH
Decimal full width: 1, 2, 3, 4

AIUEO = 20

public static final int AIUEO
Aiueo full width

IROHA = 21

public static final int IROHA
Iroha full width

LEADING_ZERO = 22

public static final int LEADING_ZERO
Leading Zero (01, 02,..., 09, 10, 11,..., 99, 100, 101,...)

BULLET = 23

public static final int BULLET
Bullet (check the character code in the text)

GANADA = 24

public static final int GANADA
Korean Ganada

CHOSUNG = 25

public static final int CHOSUNG
Korea Chosung

GB_1 = 26

public static final int GB_1
Enclosed full stop

GB_2 = 27

public static final int GB_2
Enclosed parenthesis

GB_3 = 28

public static final int GB_3
Enclosed circle Chinese

GB_4 = 29

public static final int GB_4
Ideograph enclosed circle

ZODIAC_1 = 30

public static final int ZODIAC_1
Ideograph traditional

ZODIAC_2 = 31

public static final int ZODIAC_2
Ideograph Zodiac

ZODIAC_3 = 32

public static final int ZODIAC_3
Ideograph Zodiac traditional

TRAD_CHIN_NUM_1 = 33

public static final int TRAD_CHIN_NUM_1
Taiwanese counting

TRAD_CHIN_NUM_2 = 34

public static final int TRAD_CHIN_NUM_2
Ideograph legal traditional

TRAD_CHIN_NUM_3 = 35

public static final int TRAD_CHIN_NUM_3
Taiwanese counting thousand

TRAD_CHIN_NUM_4 = 36

public static final int TRAD_CHIN_NUM_4
Taiwanese digital

SIMP_CHIN_NUM_1 = 37

public static final int SIMP_CHIN_NUM_1
Chinese counting

SIMP_CHIN_NUM_2 = 38

public static final int SIMP_CHIN_NUM_2
Chinese legal simplified

SIMP_CHIN_NUM_3 = 39

public static final int SIMP_CHIN_NUM_3
Chinese counting thousand

SIMP_CHIN_NUM_4 = 40

public static final int SIMP_CHIN_NUM_4
Chinese (not implemented)

HANJA_READ = 41

public static final int HANJA_READ
Korean digital

HANJA_READ_DIGIT = 42

public static final int HANJA_READ_DIGIT
Korean counting

HANGUL = 43

public static final int HANGUL
Korea legal

HANJA = 44

public static final int HANJA
Korea digital2

HEBREW_1 = 45

public static final int HEBREW_1
Hebrew-1

ARABIC_1 = 46

public static final int ARABIC_1
Arabic alpha

HEBREW_2 = 47

public static final int HEBREW_2
Hebrew-2

ARABIC_2 = 48

public static final int ARABIC_2
Arabic abjad

HINDI_LETTER_1 = 49

public static final int HINDI_LETTER_1
Hindi vowels

HINDI_LETTER_2 = 50

public static final int HINDI_LETTER_2
Hindi consonants

HINDI_ARABIC = 51

public static final int HINDI_ARABIC
Hindi numbers

HINDI_CARDINAL_TEXT = 52

public static final int HINDI_CARDINAL_TEXT
Hindi descriptive (cardinals)

THAI_LETTER = 53

public static final int THAI_LETTER
Thai letters

THAI_ARABIC = 54

public static final int THAI_ARABIC
Thai numbers

THAI_CARDINAL_TEXT = 55

public static final int THAI_CARDINAL_TEXT
Thai descriptive (cardinals)

VIET_CARDINAL_TEXT = 56

public static final int VIET_CARDINAL_TEXT
Vietnamese descriptive (cardinals)

NUMBER_IN_DASH = 57

public static final int NUMBER_IN_DASH
Page number format: - 1 -, - 2 -, - 3 -, - 4 -

LOWERCASE_RUSSIAN = 58

public static final int LOWERCASE_RUSSIAN
Lowercase Russian alphabet

UPPERCASE_RUSSIAN = 59

public static final int UPPERCASE_RUSSIAN
Uppercase Russian alphabet

NONE = 255

public static final int NONE
No bullet or number.

CUSTOM = 65280

public static final int CUSTOM
Custom number format. It is supported by DOCX format only.
See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.

We guarantee a prompt response to any inquiry!

© 2003-2007 Aspose Pty Ltd. All rights reserved.