get_list_by_list_id method
get_list_by_list_id(list_id)
Gets a list by a list identifier.
def get_list_by_list_id(self, list_id: int):
...
Parameter | Type | Description |
---|---|---|
list_id | int | The list identifier. |
Remarks
You don’t normally need to use this method. Most of the time you apply list formatting to paragraphs just by settings the ListFormat.list property of the ListFormat object.
Returns
Returns the list object. Returns None
if a list with the specified identifier was not found.
Examples
Shows how to verify owner document properties of lists.
doc = aw.Document()
lists = doc.lists
self.assertEqual(doc, lists.document)
list = lists.add(aw.lists.ListTemplate.BULLET_DEFAULT)
self.assertEqual(doc, list.document)
print('Current list count:', lists.count)
print('Is the first document list:', lists[0] is list)
print('List id:', list.list_id)
print('List is the same by list_id:', lists.get_list_by_list_id(1) is list)
See Also
- module aspose.words.lists
- class ListCollection