List
Overview
List is a class in Aspose.Words FOSS for Java.
Inherits from: Comparable<List>, Cloneable.
The List class models a document list, exposing its identifier, level collection, style, and methods to compare list templates or check multi‑level status.
Edition status of its 20 listed members (a property and its accessor methods are listed separately, overloads once): 20 not yet exercised by a verified example.
This class declares 14 methods for List objects in Java programs.
Available methods include: compareTo, equals, getDocument, getListId, getListLevels, getStyle, hasSameTemplate, hashCode, isListStyleDefinition, isListStyleReference, isMultiLevel, isRestartAtEachSection.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: document, listId, listLevels, listStyleDefinition, listStyleReference, multiLevel, and 2 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
listId | int | Read | Gets the unique identifier of the list. |
document | DocumentBase | Read | Gets the owner document. |
multiLevel | boolean | Read | Returns true when the list contains 9 levels; false when 1 level. |
listLevels | ListLevelCollection | Read | Gets the collection of list levels for this list. |
restartAtEachSection | boolean | Read/Write | Specifies whether list should be restarted at each section. |
listStyleDefinition | boolean | Read | Returns true if this list is a definition of a list style. |
listStyleReference | boolean | Read | Returns true if this list is a reference to a list style. |
style | Style | Read | Gets the list style that this list references or defines. |
Methods
| Signature | Description |
|---|---|
equals(list: List) → boolean | Compares with the specified list. |
equals(obj: Object) → boolean | Determines whether the specified object is equal in value to the current object. |
hashCode() → int | Calculates hash code for this list object. |
getListId() → int | Gets the unique identifier of the list. |
getDocument() → DocumentBase | Gets the owner document. |
isMultiLevel() → boolean | Returns true when the list contains 9 levels; false when 1 level. |
getListLevels() → ListLevelCollection | Gets the collection of list levels for this list. |
isRestartAtEachSection() → boolean | Specifies whether list should be restarted at each section. |
isRestartAtEachSection(value: boolean) | Calls isRestartAtEachSection(value) on this List instance. |
isListStyleDefinition() → boolean | Returns true if this list is a definition of a list style. |
isListStyleReference() → boolean | Returns true if this list is a reference to a list style. |
getStyle() → Style | Gets the list style that this list references or defines. |
compareTo(other: List) → int | Compares the specified list to the current list. |
hasSameTemplate(other: List) → boolean | Returns true if the current list and the given list are created from the same template. |