com.aspose.words

Class ListTrailingCharacter

java.lang.Object

com.aspose.words.ListTrailingCharacter

public class ListTrailingCharacter
extends java.lang.Object

Specifies the character that separates the list label from the text of the paragraph.

Remarks:

Used as a value for the ListLevel.getTrailingCharacter() / ListLevel.setTrailingCharacter(int) property.

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	length
static int	NOTHING There is no separator character between the list label and text of the paragraph.
static int	SPACE A space character is placed between the list label and text of the paragraph.
static int	TAB A tab character is placed between the list label and text of the paragraph.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String listTrailingCharacterName)
static java.lang.String	getName(int listTrailingCharacter)
static int[]	getValues()
static java.lang.String	toString(int listTrailingCharacter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAB

public static int TAB

A tab character is placed between the list label and text of the paragraph.

SPACE

public static int SPACE

A space character is placed between the list label and text of the paragraph.

NOTHING

public static int NOTHING

There is no separator character between the list label and text of the paragraph.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int listTrailingCharacter)

toString

public static java.lang.String toString(int listTrailingCharacter)

fromName

public static int fromName(java.lang.String listTrailingCharacterName)

getValues

public static int[] getValues()