ListFormat (Aspose.Words for Java API Reference)

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

```
public class ListFormat
extends java.lang.Object
```
Allows to control what list formatting is applied to a paragraph.
A paragraph in a Microsoft Word document can be bulleted or numbered. When a paragraph is bulleted or numbered, it is said that list formatting is applied to the paragraph.

You do not create objects of the ListFormat class directly. You access ListFormat as a property of another object that can have list formatting associated with it. At the moment the objects that can have list formatting are: Paragraph, Style and DocumentBuilder.

ListFormat of a Paragraph specifies what list formatting and list level is applied to that particular paragraph.

ListFormat of a Style (applicable to paragraph styles only) allows to specify what list formatting and list level is applied to all paragraphs of that particular style.

ListFormat of a DocumentBuilder provides access to the list formatting at the current cursor position inside the DocumentBuilder.

The list formatting itself is stored inside a List object that is stored separately from the paragraphs. The list objects are stored inside a ListCollection collection. There is a single ListCollection collection per Document.

The paragraphs do not physically belong to a list. The paragraphs just reference a particular list object via the getList() / setList(com.aspose.words.List) property and a particular level in the list via the getListLevelNumber() / setListLevelNumber(int) property. By setting these two properties you control what bullets and numbering is applied to a paragraph.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyBulletDefault()` Starts a new default bulleted list and applies it to the paragraph.
`void`	`applyNumberDefault()` Starts a new default numbered list and applies it to the paragraph.
`List`	`getList()` Gets the list this paragraph is a member of.
`ListLevel`	`getListLevel()` Returns the list level formatting plus any formatting overrides applied to the current paragraph.
`int`	`getListLevelNumber()` Gets the list level number (0 to 8) for the paragraph.
`boolean`	`isListItem()` True when the paragraph has bulleted or numbered formatting applied to it.
`void`	`listIndent()` Increases the list level of the current paragraph by one level.
`void`	`listOutdent()` Decreases the list level of the current paragraph by one level.
`void`	`removeNumbers()` Removes numbers or bullets from the current paragraph and sets list level to zero.
`void`	`setList(List value)` Sets the list this paragraph is a member of.
`void`	`setListLevelNumber(int value)` Sets the list level number (0 to 8) for the paragraph.

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

- Method Detail
  - applyBulletDefault
```
public void applyBulletDefault()
```
    Starts a new default bulleted list and applies it to the paragraph.
    This is a shortcut method that creates a new list using the default bulleted template, applies it to the paragraph and selects the 1st list level.
    
    See Also:
    
    getList(), setList(com.aspose.words.List), removeNumbers(), getListLevelNumber(), setListLevelNumber(int)
  - applyNumberDefault
```
public void applyNumberDefault()
```
    Starts a new default numbered list and applies it to the paragraph.
    This is a shortcut method that creates a new list using the default numbered template, applies it to the paragraph and selects the 1st list level.
    
    See Also:
    
    getList(), setList(com.aspose.words.List), removeNumbers(), getListLevelNumber(), setListLevelNumber(int)
  - removeNumbers
```
public void removeNumbers()
```
    Removes numbers or bullets from the current paragraph and sets list level to zero.
    Calling this method is equivalent to setting the getList() / setList(com.aspose.words.List) property to null.
  - listIndent
```
public void listIndent()
                throws java.lang.Exception
```
    Increases the list level of the current paragraph by one level.
    This method changes the list level and applies formatting properties of the new level.
    
    In Word documents, lists may consist of up to nine levels. List formatting for each level specifies what bullet or number is used, left indent, space between the bullet and text etc.
    
    Throws:
    
    java.lang.Exception
  - listOutdent
```
public void listOutdent()
                 throws java.lang.Exception
```
    Decreases the list level of the current paragraph by one level.
    This method changes the list level and applies formatting properties of the new level.
    
    In Word documents, lists may consist of up to nine levels. List formatting for each level specifies what bullet or number is used, left indent, space between the bullet and text etc.
    
    Throws:
    
    java.lang.Exception
  - getListLevelNumber
```
public int getListLevelNumber()
```
    Gets 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 getList() / setList(com.aspose.words.List) property is set to reference a valid list.
    
    Returns:
    
    The list level number (0 to 8) for the paragraph.
    
    See Also:
    
    getList(), setList(com.aspose.words.List)
  - setListLevelNumber
```
public void setListLevelNumber(int value)
```
    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 getList() / setList(com.aspose.words.List) property is set to reference a valid list.
    
    Parameters:
    
    value - The list level number (0 to 8) for the paragraph.
    
    See Also:
    
    getList(), setList(com.aspose.words.List)
  - isListItem
```
public boolean isListItem()
```
    True when the paragraph has bulleted or numbered formatting applied to it.
    
    Returns:
    
    The corresponding boolean value.
  - getList
```
public List getList()
```
    Gets 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().
    
    Returns:
    
    The list this paragraph is a member of.
    
    See Also:
    
    getListLevelNumber(), setListLevelNumber(int), removeNumbers()
  - setList
```
public void setList(List value)
```
    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().
    
    Parameters:
    
    value - The list this paragraph is a member of.
    
    See Also:
    
    getListLevelNumber(), setListLevelNumber(int), removeNumbers()
  - getListLevel
```
public ListLevel getListLevel()
```
    Returns the list level formatting plus any formatting overrides applied to the current paragraph.
    
    Returns:
    
    The list level formatting plus any formatting overrides applied to the current paragraph.

Class ListFormat

Method Summary

Methods inherited from class java.lang.Object

Method Detail

applyBulletDefault

applyNumberDefault

removeNumbers

listIndent

listOutdent

getListLevelNumber

setListLevelNumber

isListItem

getList

setList

getListLevel