List
Overview
List is a class in Aspose.Words FOSS for .NET.
Inherits from: IComparable<List>.
List class exposes ListId, ListLevels, Style and methods like CompareTo and HasSameTemplate, allowing developers to inspect, compare, and manipulate document list definitions.
This class provides 6 methods for working with List objects in .NET programs.
Available methods include: CompareTo, Equals, GetHashCode, HasSameTemplate.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: Document, IsListStyleDefinition, IsListStyleReference, IsMultiLevel, IsRestartAtEachSection, ListId, 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. |
IsMultiLevel | bool | 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. |
IsRestartAtEachSection | bool | Read/Write | Specifies whether list should be restarted at each section. |
IsListStyleDefinition | bool | Read | Returns true if this list is a definition of a list style. |
IsListStyleReference | bool | 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) | Compares with the specified list. |
Equals(obj: object) | Determines whether the specified object is equal in value to the current object. |
GetHashCode() | Calculates hash code for this list object. |
CompareTo(obj: object) | Compares the specified object to the current object. |
CompareTo(other: List) | Compares the specified list to the current list. |
HasSameTemplate(other: List) | Returns true if the current list and the given list are created from the same template. |