custom_number_style_format property

ListLevel.custom_number_style_format property

Gets the custom number style format for this list level. For example: “a, ç, ĝ, …”.

@property
def custom_number_style_format(self) -> str:
    ...

Examples

Shows how to get the format for a list with the custom number style.

doc = aw.Document(MY_DIR + "List with leading zero.docx")

list_level = doc.first_section.body.paragraphs[0].list_format.list_level

custom_number_style_format = ""

if list_level.number_style == aw.NumberStyle.CUSTOM:
    custom_number_style_format = list_level.custom_number_style_format

self.assertEqual("001, 002, 003, ...", custom_number_style_format)

# We can get value for the specified index of the list item.
self.assertEqual("iv", list_level.get_effective_value(4, aw.NumberStyle.LOWERCASE_ROMAN, None))
self.assertEqual("005", list_level.get_effective_value(5, aw.NumberStyle.CUSTOM, custom_number_style_format))

See Also

ListLevel.alignment property ListLevel.font property