|
ASPOSE home |
java.lang.Objectcom.aspose.words.ListFormat
public class ListFormat
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 The list formatting itself is stored inside a The paragraphs do not physically belong to a list. The paragraphs just
reference a particular list object via the
Property Getters/Setters Summary | ||
---|---|---|
boolean | isListItem() | |
True when the paragraph has bulleted or numbered formatting applied to it. | ||
List | getList() | |
void | setList(List value) | |
Gets or sets the list this paragraph is a member of. | ||
ListLevel | getListLevel() | |
Returns the list level object applied to the current paragraph. | ||
int | getListLevelNumber() | |
void | setListLevelNumber(int value) | |
Gets or sets the list level number (0 to 8) for the paragraph. |
Method Summary | ||
---|---|---|
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. | ||
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. |
Property Getters/Setters Detail |
---|
getListLevelNumber/setListLevelNumber | |
public int getListLevelNumber() public void setListLevelNumber(int value) |
In Word documents, lists may consist of 1 or 9 levels, numbered 0 to 8.
Has effect only when the
isListItem | |
public boolean isListItem() |
getList/setList | |
public List getList() public void setList(List value) |
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
getListLevel | |
public ListLevel getListLevel() |
Method Detail |
---|
applyBulletDefault | |
public void applyBulletDefault() throws java.lang.Exception |
This is a shorctut method that creates a new list using the default bulleted template, applies it to the paragraph and selects the 1st list level.
applyNumberDefault | |
public void applyNumberDefault() throws java.lang.Exception |
This is a shorctut method that creates a new list using the default numbered template, applies it to the paragraph and selects the 1st list level.
removeNumbers | |
public void removeNumbers() throws java.lang.Exception |
Calling this method is equivalent to setting the
listIndent | |
public void listIndent() throws java.lang.Exception |
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.
listOutdent | |
public void listOutdent() throws java.lang.Exception |
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.
|
ASPOSE home |