ooodev.adapter.text.textfield.page_number_comp module

class ooodev.adapter.text.textfield.page_number_comp.PageNumberComp(component)[source]

Bases: TextFieldComp

Class for managing PageNumber Component.

Parameters:

component (XTextField) –

__init__(component)[source]

Constructor

Parameters:

component (XTextField) – UNO PageNumber Component that supports com.sun.star.text.textfield.PageNumber service.

Return type:

None

property number_type: NumberingTypeEnum

Gets or sets the numbering type.

Return type:

NumberingTypeEnum

property offset: int

Gets or sets an offset value to show a different page number.

Return type:

int

property sub_type: PageNumberType

Gets or sets the numbering type.

Return type:

PageNumberType

property user_text: str

Gets or sets the user text.

If the user text string is set then it is displayed when the value of NumberingType is set to com.sun.star.style.NumberingType.CHAR_SPECIAL

Return type:

str