com.aspose.words
Class ListFormat

java.lang.Object
    com.aspose.words.ListFormat

public class ListFormat 
extends java.lang.Object

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

// Create a numbered list based on one of the Microsoft Word list templates and
// apply it to the current paragraph in the document builder.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.NUMBER_ARABIC_DOT));

// There are 9 levels in this list, lets try them all.
for (int i = 0; i < 9; i++)
{
    builder.getListFormat().setListLevelNumber(i);
    builder.writeln("Level " + i);
}


// Create a bulleted list based on one of the Microsoft Word list templates
// and apply it to the current paragraph in the document builder.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DIAMONDS));

// There are 9 levels in this list, lets try them all.
for (int i = 0; i < 9; i++)
{
    builder.getListFormat().setListLevelNumber(i);
    builder.writeln("Level " + i);
}

// This is a way to stop list formatting.
builder.getListFormat().setList(null);

builder.getDocument().save(getMyDir() + "Lists.SpecifyListLevel Out.doc");

public int getListLevelNumber() / public void setListLevelNumber(int value)

Gets or sets the list level number (0 to 8) for the paragraph.

In Word documents, lists may consist of 1 or 9 levels, numbered 0 to 8.

Has effect only when the List property is set to reference a valid list.

Example:

Applies list formatting of an existing list to a collection of paragraphs.

Body body = doc.getFirstSection().getBody();
List list = doc.getLists().get(0);
for (Paragraph paragraph : body.getParagraphs())
{
    paragraph.getListFormat().setList(list);
    paragraph.getListFormat().setListLevelNumber(2);
}

Example:

Creates new list formatting and applies it to a collection of paragraphs.

List list = doc.getLists().add(ListTemplate.NUMBER_UPPERCASE_LETTER_DOT);

Body body = doc.getFirstSection().getBody();
for (Paragraph paragraph : body.getParagraphs())
{
    paragraph.getListFormat().setList(list);
    paragraph.getListFormat().setListLevelNumber(1);
}

Example:

Shows how to specify list level number when building a list using DocumentBuilder.

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

// Create a numbered list based on one of the Microsoft Word list templates and
// apply it to the current paragraph in the document builder.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.NUMBER_ARABIC_DOT));

// There are 9 levels in this list, lets try them all.
for (int i = 0; i < 9; i++)
{
    builder.getListFormat().setListLevelNumber(i);
    builder.writeln("Level " + i);
}


// Create a bulleted list based on one of the Microsoft Word list templates
// and apply it to the current paragraph in the document builder.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DIAMONDS));

// There are 9 levels in this list, lets try them all.
for (int i = 0; i < 9; i++)
{
    builder.getListFormat().setListLevelNumber(i);
    builder.writeln("Level " + i);
}

// This is a way to stop list formatting.
builder.getListFormat().setList(null);

builder.getDocument().save(getMyDir() + "Lists.SpecifyListLevel Out.doc");

See Also:

List

public boolean isListItem()

True when the paragraph has bulleted or numbered formatting applied to it.

Example:

Finds and outputs all paragraphs in a document that are bulleted or numbered.

NodeCollection<Paragraph> paras = doc.getChildNodes(NodeType.PARAGRAPH, true);
for (Paragraph para : paras)
{
    if (para.getListFormat().isListItem())
    {
        System.out.println(MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId()));
        System.out.println(para.getText());
    }
}

public List getList() / public void setList(List value)

Gets or sets the list this paragraph is a member of.

The list that is being assigned to this property must belong to the current document.

The list that is being assigned to this property must not be a list style definition.

Setting this property to null removes bullets and numbering from the paragraph and sets the list level number to zero. Setting this property to null is equivalent to calling removeNumbers().

Example:

Applies list formatting of an existing list to a collection of paragraphs.

Body body = doc.getFirstSection().getBody();
List list = doc.getLists().get(0);
for (Paragraph paragraph : body.getParagraphs())
{
    paragraph.getListFormat().setList(list);
    paragraph.getListFormat().setListLevelNumber(2);
}

Example:

Shows how to specify list level number when building a list using DocumentBuilder.

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

// Create a numbered list based on one of the Microsoft Word list templates and
// apply it to the current paragraph in the document builder.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.NUMBER_ARABIC_DOT));

// There are 9 levels in this list, lets try them all.
for (int i = 0; i < 9; i++)
{
    builder.getListFormat().setListLevelNumber(i);
    builder.writeln("Level " + i);
}


// Create a bulleted list based on one of the Microsoft Word list templates
// and apply it to the current paragraph in the document builder.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DIAMONDS));

// There are 9 levels in this list, lets try them all.
for (int i = 0; i < 9; i++)
{
    builder.getListFormat().setListLevelNumber(i);
    builder.writeln("Level " + i);
}

// This is a way to stop list formatting.
builder.getListFormat().setList(null);

builder.getDocument().save(getMyDir() + "Lists.SpecifyListLevel Out.doc");

Example:

Shows how to restart numbering in a list by copying a list.

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

// Create a list based on a template.
List list1 = doc.getLists().add(ListTemplate.NUMBER_ARABIC_PARENTHESIS);
// Modify the formatting of the list.
list1.getListLevels().get(0).getFont().setColor(Color.RED);
list1.getListLevels().get(0).setAlignment(ListLevelAlignment.RIGHT);

builder.writeln("List 1 starts below:");
// Use the first list in the document for a while.
builder.getListFormat().setList(list1);
builder.writeln("Item 1");
builder.writeln("Item 2");
builder.getListFormat().removeNumbers();

// Now I want to reuse the first list, but need to restart numbering.
// This should be done by creating a copy of the original list formatting.
List list2 = doc.getLists().addCopy(list1);

// We can modify the new list in any way. Including setting new start number.
list2.getListLevels().get(0).setStartAt(10);

// Use the second list in the document.
builder.writeln("List 2 starts below:");
builder.getListFormat().setList(list2);
builder.writeln("Item 1");
builder.writeln("Item 2");
builder.getListFormat().removeNumbers();

builder.getDocument().save(getMyDir() + "Lists.RestartNumberingUsingListCopy Out.doc");

Example:

Shows how to start a numbered list, add a bulleted list inside it, then return to the numbered list.

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

// Create an outline list for the headings.
List outlineList = doc.getLists().add(ListTemplate.OUTLINE_NUMBERS);
builder.getListFormat().setList(outlineList);
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
builder.writeln("This is my Chapter 1");

// Create a numbered list.
List numberedList = doc.getLists().add(ListTemplate.NUMBER_DEFAULT);
builder.getListFormat().setList(numberedList);
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.NORMAL);
builder.writeln("Numebered list item 1.");

// Create a bulleted list.
List bulletedList = doc.getLists().add(ListTemplate.BULLET_DEFAULT);
builder.getListFormat().setList(bulletedList);
builder.getParagraphFormat().setLeftIndent(72);
builder.writeln("Bulleted list item 1.");
builder.writeln("Bulleted list item 2.");
builder.getParagraphFormat().clearFormatting();

// Revert to the numbered list.
builder.getListFormat().setList(numberedList);
builder.writeln("Numbered list item 2.");
builder.writeln("Numbered list item 3.");

// Revert to the outline list.
builder.getListFormat().setList(outlineList);
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
builder.writeln("This is my Chapter 2");

builder.getParagraphFormat().clearFormatting();

builder.getDocument().save(getMyDir() + "Lists.NestedLists Out.doc");

See Also:

ListLevelNumber, removeNumbers()

public ListLevel getListLevel()

Returns the list level object applied to the current paragraph.

Example:

Shows how to modify list formatting of the current list level.

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

// Create and apply list formatting to the current paragraph.
builder.getListFormat().setList(doc.getLists().add(ListTemplate.NUMBER_DEFAULT));

// Modify formatting of the current (first) list level.
builder.getListFormat().getListLevel().getFont().setBold(true);

builder.writeln("Item 1");
builder.writeln("Item 2");
builder.getListFormat().removeNumbers();