FieldIndexFormat
Contents
[
Hide
]Inheritance: java.lang.Object
public class FieldIndexFormat
Specifies the formatting for the FieldIndex fields in a document.
Examples:
Shows how to formatting FieldIndex fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("A");
builder.insertBreak(BreakType.LINE_BREAK);
builder.insertField("XE \"A\"");
builder.write("B");
builder.insertField(" INDEX \\e \" \" \\h \"A\" \\c \"2\" \\z \"1033\"", null);
doc.getFieldOptions().setFieldIndexFormat(FieldIndexFormat.FANCY);
doc.updateFields();
doc.save(getArtifactsDir() + "Field.SetFieldIndexFormat.docx");
Fields
| Field | Description |
|---|---|
| BULLETED | Bulleted. |
| CLASSIC | Classic. |
| FANCY | Fancy. |
| FORMAL | Formal. |
| MODERN | Modern. |
| SIMPLE | Simple. |
| TEMPLATE | From template. |
| length |
Methods
| Method | Description |
|---|---|
| fromName(String fieldIndexFormatName) | |
| getName(int fieldIndexFormat) | |
| getValues() | |
| toString(int fieldIndexFormat) |
BULLETED
public static int BULLETED
Bulleted.
CLASSIC
public static int CLASSIC
Classic.
FANCY
public static int FANCY
Fancy.
FORMAL
public static int FORMAL
Formal.
MODERN
public static int MODERN
Modern.
SIMPLE
public static int SIMPLE
Simple.
TEMPLATE
public static int TEMPLATE
From template.
length
public static int length
fromName(String fieldIndexFormatName)
public static int fromName(String fieldIndexFormatName)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldIndexFormatName | java.lang.String |
Returns: int
getName(int fieldIndexFormat)
public static String getName(int fieldIndexFormat)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldIndexFormat | int |
Returns: java.lang.String
getValues()
public static int[] getValues()
Returns: int[]
toString(int fieldIndexFormat)
public static String toString(int fieldIndexFormat)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldIndexFormat | int |
Returns: java.lang.String
