GeneralFormat (Aspose.Words for Java API Reference)

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

public class GeneralFormat
extends java.lang.Object

Specifies a general format that is applied to a numeric, text, or any field result. A field may have a combination of general formats.

Examples:

Shows how to format field results.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Use a document builder to insert a field that displays a result with no format applied.
 Field field = builder.insertField("= 2 + 3");

 Assert.assertEquals("= 2 + 3", field.getFieldCode());
 Assert.assertEquals("5", field.getResult());

 // We can apply a format to a field's result using the field's properties.
 // Below are three types of formats that we can apply to a field's result.
 // 1 -  Numeric format:
 FieldFormat format = field.getFormat();
 format.setNumericFormat("$###.00");
 field.update();

 Assert.assertEquals("= 2 + 3 \\# $###.00", field.getFieldCode());
 Assert.assertEquals("$  5.00", field.getResult());

 // 2 -  Date/time format:
 field = builder.insertField("DATE");
 format = field.getFormat();
 format.setDateTimeFormat("dddd, MMMM dd, yyyy");
 field.update();

 Assert.assertEquals("DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode());
 System.out.println("Today's date, in {format.DateTimeFormat} format:\n\t{field.Result}");

 // 3 -  General format:
 field = builder.insertField("= 25 + 33");
 format = field.getFormat();
 format.getGeneralFormats().add(GeneralFormat.LOWERCASE_ROMAN);
 format.getGeneralFormats().add(GeneralFormat.UPPER);
 field.update();

 int index = 0;
 Iterator<Integer> generalFormatEnumerator = format.getGeneralFormats().iterator();
 while (generalFormatEnumerator.hasNext()) {
     int value = generalFormatEnumerator.next();
     System.out.println(MessageFormat.format("General format index {0}: {1}", index++, value));
 }

 Assert.assertEquals("= 25 + 33 \\* roman \\* Upper", field.getFieldCode());
 Assert.assertEquals("LVIII", field.getResult());
 Assert.assertEquals(2, format.getGeneralFormats().getCount());
 Assert.assertEquals(GeneralFormat.LOWERCASE_ROMAN, format.getGeneralFormats().get(0));

 // We can remove our formats to revert the field's result to its original form.
 format.getGeneralFormats().remove(GeneralFormat.LOWERCASE_ROMAN);
 format.getGeneralFormats().removeAt(0);
 Assert.assertEquals(0, format.getGeneralFormats().getCount());
 field.update();

 Assert.assertEquals("= 25 + 33  ", field.getFieldCode());
 Assert.assertEquals("58", field.getResult());
 Assert.assertEquals(0, format.getGeneralFormats().getCount());

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AIUEO` Numeric formatting.
`static int`	`ARABIC` Numeric formatting.
`static int`	`ARABIC_ABJAD` Numeric formatting.
`static int`	`ARABIC_ALPHA` Numeric formatting.
`static int`	`ARABIC_DASH` Numeric formatting.
`static int`	`BAHT_TEXT` Numeric formatting.
`static int`	`CAPS` Text formatting.
`static int`	`CARD_TEXT` Numeric formatting.
`static int`	`CHAR_FORMAT` Field result formatting.
`static int`	`CHINESE_NUM_1` Numeric formatting.
`static int`	`CHINESE_NUM_2` Numeric formatting.
`static int`	`CHINESE_NUM_3` Numeric formatting.
`static int`	`CHOSUNG` Numeric formatting.
`static int`	`CIRCLE_NUM` Numeric formatting.
`static int`	`DB_CHAR`
`static int`	`DB_NUM_1`
`static int`	`DB_NUM_2`
`static int`	`DB_NUM_3`
`static int`	`DB_NUM_4`
`static int`	`DOLLAR_TEXT` Numeric formatting.
`static int`	`FIRST_CAP` Text formatting.
`static int`	`GANADA` Numeric formatting.
`static int`	`GB_1` Numeric formatting.
`static int`	`GB_2` Numeric formatting.
`static int`	`GB_3` Numeric formatting.
`static int`	`GB_4` Numeric formatting.
`static int`	`HEBREW_1` Numeric formatting.
`static int`	`HEBREW_2` Numeric formatting.
`static int`	`HEX` Numeric formatting.
`static int`	`HINDI_ARABIC` Numeric formatting.
`static int`	`HINDI_CARD_TEXT` Numeric formatting.
`static int`	`HINDI_LETTER_1` Numeric formatting.
`static int`	`HINDI_LETTER_2` Numeric formatting.
`static int`	`IROHA` Numeric formatting.
`static int`	`KANJI_NUM_1` Numeric formatting.
`static int`	`KANJI_NUM_2` Numeric formatting.
`static int`	`KANJI_NUM_3` Numeric formatting.
`static int`	`length`
`static int`	`LOWER` Text formatting.
`static int`	`LOWERCASE_ALPHABETIC` Numeric formatting.
`static int`	`LOWERCASE_ROMAN` Numeric formatting.
`static int`	`MERGE_FORMAT` Field result formatting.
`static int`	`MERGE_FORMAT_INET` Field result formatting.
`static int`	`NONE` Used to specify a missing general format.
`static int`	`ORD_TEXT` Numeric formatting.
`static int`	`ORDINAL` Numeric formatting.
`static int`	`SB_CHAR`
`static int`	`THAI_ARABIC` Numeric formatting.
`static int`	`THAI_CARD_TEXT` Numeric formatting.
`static int`	`THAI_LETTER` Numeric formatting.
`static int`	`UPPER` Text formatting.
`static int`	`UPPERCASE_ALPHABETIC` Numeric formatting.
`static int`	`UPPERCASE_ROMAN` Numeric formatting.
`static int`	`VIET_CARD_TEXT` Numeric formatting.
`static int`	`ZODIAC_1` Numeric formatting.
`static int`	`ZODIAC_2` Numeric formatting.
`static int`	`ZODIAC_3` Numeric formatting.

Method Summary

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

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

- Field Detail
  - NONE
```
public static int NONE
```
    Used to specify a missing general format.
  - AIUEO
```
public static int AIUEO
```
    Numeric formatting. Formats a numeric result using hiragana characters in the traditional a-i-u-e-o order.
  - UPPERCASE_ALPHABETIC
```
public static int UPPERCASE_ALPHABETIC
```
    Numeric formatting. Formats a numeric result as one or more occurrences of an uppercase alphabetic Latin character.
  - LOWERCASE_ALPHABETIC
```
public static int LOWERCASE_ALPHABETIC
```
    Numeric formatting. Formats a numeric result as one or more occurrences of an lowercase alphabetic Latin character.
  - ARABIC
```
public static int ARABIC
```
    Numeric formatting. Formats a numeric result using Arabic cardinal numerals.
  - ARABIC_ABJAD
```
public static int ARABIC_ABJAD
```
    Numeric formatting. Formats a numeric result using ascending Abjad numerals.
  - ARABIC_ALPHA
```
public static int ARABIC_ALPHA
```
    Numeric formatting. Formats a numeric result using characters in the Arabic alphabet.
  - ARABIC_DASH
```
public static int ARABIC_DASH
```
    Numeric formatting. Formats a numeric result using Arabic cardinal numerals, with a prefix of "- " and a suffix of " -".
  - BAHT_TEXT
```
public static int BAHT_TEXT
```
    Numeric formatting. Formats a numeric result in the Thai counting system.
  - CARD_TEXT
```
public static int CARD_TEXT
```
    Numeric formatting. Cardinal text (One, Two, Three, ...).
  - CHINESE_NUM_1
```
public static int CHINESE_NUM_1
```
    Numeric formatting. Formats a numeric result using ascending numbers from the appropriate counting system.
  - CHINESE_NUM_2
```
public static int CHINESE_NUM_2
```
    Numeric formatting. Formats a numeric result using sequential numbers from the appropriate legal format.
  - CHINESE_NUM_3
```
public static int CHINESE_NUM_3
```
    Numeric formatting. Formats a numeric result using sequential numbers from the appropriate counting thousand system.
  - CHOSUNG
```
public static int CHOSUNG
```
    Numeric formatting. Formats a numeric result using sequential numbers from the Korean Chosung format.
  - CIRCLE_NUM
```
public static int CIRCLE_NUM
```
    Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character for numbers in the range 1–20.
  - DB_CHAR
```
public static int DB_CHAR
```
  - DB_NUM_1
```
public static int DB_NUM_1
```
  - DB_NUM_2
```
public static int DB_NUM_2
```
  - DB_NUM_3
```
public static int DB_NUM_3
```
  - DB_NUM_4
```
public static int DB_NUM_4
```
  - DOLLAR_TEXT
```
public static int DOLLAR_TEXT
```
    Numeric formatting. Dollar text (One, Two, Three, ... + AND 55/100).
  - GANADA
```
public static int GANADA
```
    Numeric formatting. Formats a numeric result using sequential numbers from the Korean Ganada format.
  - GB_1
```
public static int GB_1
```
    Numeric formatting. Formats a numeric result using decimal numbering followed by a period, using the enclosed alphanumeric glyph character.
  - GB_2
```
public static int GB_2
```
    Numeric formatting. Formats a numeric result using decimal numbering enclosed in parenthesis, using the enclosed alphanumeric glyph character.
  - GB_3
```
public static int GB_3
```
    Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character.
  - GB_4
```
public static int GB_4
```
    Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character.
  - HEBREW_1
```
public static int HEBREW_1
```
    Numeric formatting. Formats a numeric result using Hebrew numerals.
  - HEBREW_2
```
public static int HEBREW_2
```
    Numeric formatting. Formats a numeric result using the Hebrew alphabet.
  - HEX
```
public static int HEX
```
    Numeric formatting. Formats the numeric result using uppercase hexadecimal digits.
  - HINDI_ARABIC
```
public static int HINDI_ARABIC
```
    Numeric formatting. Formats a numeric result using Hindi numbers.
  - HINDI_CARD_TEXT
```
public static int HINDI_CARD_TEXT
```
    Numeric formatting. Formats a numeric result using sequential numbers from the Hindi counting system.
  - HINDI_LETTER_1
```
public static int HINDI_LETTER_1
```
    Numeric formatting. Formats a numeric result using Hindi vowels.
  - HINDI_LETTER_2
```
public static int HINDI_LETTER_2
```
    Numeric formatting. Formats a numeric result using Hindi consonants.
  - IROHA
```
public static int IROHA
```
    Numeric formatting. Formats a numeric result using the Japanese iroha.
  - KANJI_NUM_1
```
public static int KANJI_NUM_1
```
    Numeric formatting. Formats a numeric result using a Japanese style using the appropriate counting system.
  - KANJI_NUM_2
```
public static int KANJI_NUM_2
```
    Numeric formatting. Formats a numeric result using the appropriate counting system.
  - KANJI_NUM_3
```
public static int KANJI_NUM_3
```
    Numeric formatting. Formats a numeric result using the appropriate counting system.
  - ORDINAL
```
public static int ORDINAL
```
    Numeric formatting. Ordinal (1st, 2nd, 3rd, ...).
  - ORD_TEXT
```
public static int ORD_TEXT
```
    Numeric formatting. Ordinal text (First, Second, Third, ...).
  - UPPERCASE_ROMAN
```
public static int UPPERCASE_ROMAN
```
    Numeric formatting. Uppercase Roman (I, II, III, ...).
  - LOWERCASE_ROMAN
```
public static int LOWERCASE_ROMAN
```
    Numeric formatting. Lowercase Roman (i, ii, iii, ...).
  - SB_CHAR
```
public static int SB_CHAR
```
  - THAI_ARABIC
```
public static int THAI_ARABIC
```
    Numeric formatting. Formats a numeric result using Thai numbers.
  - THAI_CARD_TEXT
```
public static int THAI_CARD_TEXT
```
    Numeric formatting. Formats a numeric result using sequential numbers from the Thai counting system.
  - THAI_LETTER
```
public static int THAI_LETTER
```
    Numeric formatting. Formats a numeric result using Thai letters.
  - VIET_CARD_TEXT
```
public static int VIET_CARD_TEXT
```
    Numeric formatting. Formats a numeric result using Vietnamese numerals.
  - ZODIAC_1
```
public static int ZODIAC_1
```
    Numeric formatting. Formats a numeric result using sequential numerical traditional ideographs.
  - ZODIAC_2
```
public static int ZODIAC_2
```
    Numeric formatting. Formats a numeric result using sequential zodiac ideographs.
  - ZODIAC_3
```
public static int ZODIAC_3
```
    Numeric formatting. Formats a numeric result using sequential traditional zodiac ideographs.
  - CAPS
```
public static int CAPS
```
    Text formatting. Capitalizes the first letter of each word.
  - FIRST_CAP
```
public static int FIRST_CAP
```
    Text formatting. Capitalizes the first letter of the first word.
  - LOWER
```
public static int LOWER
```
    Text formatting. All letters are lowercase.
  - UPPER
```
public static int UPPER
```
    Text formatting. All letters are uppercase.
  - CHAR_FORMAT
```
public static int CHAR_FORMAT
```
    Field result formatting. The CHARFORMAT instruction.
  - MERGE_FORMAT
```
public static int MERGE_FORMAT
```
    Field result formatting. The MERGEFORMAT instruction.
  - MERGE_FORMAT_INET
```
public static int MERGE_FORMAT_INET
```
    Field result formatting. The MERGEFORMATINET instruction.
  - length
```
public static int length
```
- Method Detail
  - getName
```
public static java.lang.String getName(int generalFormat)
```
  - toString
```
public static java.lang.String toString(int generalFormat)
```
  - fromName
```
public static int fromName(java.lang.String generalFormatName)
```
  - getValues
```
public static int[] getValues()
```

Class GeneralFormat

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

AIUEO

UPPERCASE_ALPHABETIC

LOWERCASE_ALPHABETIC

ARABIC

ARABIC_ABJAD

ARABIC_ALPHA

ARABIC_DASH

BAHT_TEXT

CARD_TEXT

CHINESE_NUM_1

CHINESE_NUM_2

CHINESE_NUM_3

CHOSUNG

CIRCLE_NUM

DB_CHAR

DB_NUM_1

DB_NUM_2

DB_NUM_3

DB_NUM_4

DOLLAR_TEXT

GANADA

GB_1

GB_2

GB_3

GB_4

HEBREW_1

HEBREW_2

HEX

HINDI_ARABIC

HINDI_CARD_TEXT

HINDI_LETTER_1

HINDI_LETTER_2

IROHA

KANJI_NUM_1

KANJI_NUM_2

KANJI_NUM_3

ORDINAL

ORD_TEXT

UPPERCASE_ROMAN

LOWERCASE_ROMAN

SB_CHAR

THAI_ARABIC

THAI_CARD_TEXT

THAI_LETTER

VIET_CARD_TEXT

ZODIAC_1

ZODIAC_2

ZODIAC_3

CAPS

FIRST_CAP

LOWER

UPPER

CHAR_FORMAT

MERGE_FORMAT

MERGE_FORMAT_INET

length

Method Detail

getName

toString

fromName

getValues