TextList

Overview

TextList is a class in Aspose.PDF FOSS for Python.

Items ready to be placed on a page, with the styles they share.

This class declares 7 methods for TextList objects in Python programs. Available methods include: __post_init__, add_item, any_text, label_for, marker_for, numbering_attribute, numbering_for. Public members are accessible to any Python application after installing the Aspose.PDF FOSS for Python package. Properties: alignment, font, font_name, font_size, indent, is_empty, and 13 more.

Properties

NameTypeAccessDescription
is_emptyboolReadWhether there is nothing here that would put a mark on a page.
itemsAnyRead/WriteGets or sets the items.
orderedboolRead/WriteGets or sets the ordered.
markersAnyRead/WriteGets or sets the markers.
numberingAnyRead/WriteGets or sets the numbering.
number_formatstrRead/WriteGets or sets the number format.
startintRead/WriteGets or sets the start.
indentfloatRead/WriteGets or sets the indent.
label_gapfloatRead/WriteGets or sets the label gap.
label_widthfloat | NoneRead/WriteGets or sets the label width.
label_alignmentstrRead/WriteGets or sets the label alignment.
widthfloat | NoneRead/WriteGets or sets the width.
font_namestrRead/WriteGets or sets the font name.
font_sizefloatRead/WriteGets or sets the font size.
fontAnyRead/WriteGets or sets the font.
text_colorAnyRead/WriteGets or sets the text color.
alignmentstrRead/WriteGets or sets the alignment.
line_heightfloat | NoneRead/WriteGets or sets the line height.
item_gapfloatRead/WriteGets or sets the item gap.

Methods

SignatureDescription
__post_init__()Calls post_init on this TextList instance.
add_item(text: Any) → ListItemAppend an item and return it.
marker_for(depth: int) → strThe bullet for depth, cycling through :attr:markers.
numbering_for(depth: int) → strThe numbering style for depth, cycling through :attr:numbering.
label_for(depth: int, position: int) → strThe marker an item at depth in position (counting from 1) gets.
numbering_attribute(depth: int) → str | None/ListNumbering for depth: what the markers mean, as a name.
any_text(items: Sequence[ListItem]) → boolCalls any_text(items) on this TextList instance.

See Also