java.lang.Objectcom.aspose.words.List
public class List
A list in a Microsoft Word document is a set of list formatting properties.
Each list can have up to 9 levels and formatting properties, such as number style, start value,
indent, tab position etc are defined separately for each level. A To create a new list, use the Add methods of the To modify formatting of a list, use To apply or remove list formatting from a paragraph, use
Property Getters/Setters Summary | ||
---|---|---|
Aspose.Words.DocumentBase | getDocument() | |
Gets the owner document. | ||
boolean | isListStyleDefinition() | |
Returns true if this list is a definition of a list style. | ||
boolean | isListStyleReference() | |
Returns true if this list is a reference to a list style. | ||
boolean | isMultiLevel() | |
Returns true when the list contains 9 levels; false when 1 level. | ||
int | getListId() | |
Gets the unique identifier of the list. | ||
ListLevelCollection | getListLevels() | |
Gets the collection of list levels for this list. | ||
Aspose.Words.Style | getStyle() | |
Gets the list style that this list references or defines. |
Method Summary | ||
---|---|---|
int | compareTo(java.lang.Object obj) | |
Property Getters/Setters Detail |
---|
getDocument | |
public Aspose.Words.DocumentBase getDocument() |
A list always has a parent document and is valid only in the context of that document.
isListStyleDefinition | |
public boolean isListStyleDefinition() |
When this property is true, the
By modifying properties of a list that defines a list style, you modify the properties of the list style.
A list that is a definition of a list style cannot be applied directly to paragraphs to make them numbered.
isListStyleReference | |
public boolean isListStyleReference() |
Note, modifying properties of a list that is a reference to list style has no effect. The list formatting specified in the list style itself always takes precedence.
isMultiLevel | |
public boolean isMultiLevel() |
The lists that you create with Aspose.Words are always multi-level lists and contain 9 levels.
Microsoft Word 2003 and later always create multi-level lists with 9 levels. But in some documents, created with earlier versions of Microsoft Word you might encounter lists that have 1 level only.
getListId | |
public int getListId() |
You do not normally need to use this property. But if you use it, you normally do so
in conjunction with the
getListLevels | |
public ListLevelCollection getListLevels() |
Use this property to access and modify formatting individual to each level of the list.
getStyle | |
public Aspose.Words.Style getStyle() |
If this list is not associated with a list style, the property will return null.
A list could be a reference to a list style, in this case
A list could be a definition of a list style, in this case
Method Detail |
---|
compareTo | |
public int compareTo(java.lang.Object obj) |
obj
-