ooodev.format.inner.modify.calc.page.sheet.order module
- class ooodev.format.inner.modify.calc.page.sheet.order.Order(*, top_btm=None, first_pg=None, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]
Bases:
CellStyleBase
Page Style Order.
See also
New in version 0.9.0.
- __init__(*, top_btm=None, first_pg=None, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]
Constructor
- Parameters:
top_btm (bool, optional) – Specifies page order.
True
for Top to Bottom, then right,False
for Left to right then down.first_pg (int, optional) – Specifies first page number. Set to
0
for no page number.style_name (CalcStylePageKind, str, optional) – Specifies the Page Style that instance applies to. Default is Default Page Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Return type:
None
See also
- classmethod from_style(doc, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]
Gets instance from Document.
- Parameters:
doc (object) – UNO Document Object.
style_name (CalcStylePageKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Raises:
NotSupportedError – If
obj
is not supported.- Returns:
Order
instance from document properties.- Return type:
- property prop_first_pg: int | None
Gets/Sets first page number. Set to
0
for no page number.- Return type:
int | None
- property prop_top_btm: bool | None
Gets/Sets page order.
True
for Top to Bottom, then right,False
for Left to right then down.- Return type:
bool | None