PageLayoutEvent enumeration

PageLayoutEvent enumeration

A code of event raised during page layout model build and rendering.

Page layout model is built in two steps. First, “conversion step”, this is when page layout pulls document content and creates object graph. Second, “reflow step”, this is when structures are split, merged and arranged into pages.

Depending of the operation which triggered build, page layout model may or may not be further rendered into fixed page format. For example, computing number of pages in the document or updating fields does not require rendering, whereas export to Pdf does.

Members

NameDescription
NONEDefault value
WATCH_DOGCorresponds to a checkpoint in code which is often visited and which is suitable to abort process.
BUILD_STARTEDBuild of the page layout has started. Fired once. This is the first event which occurs when Document.update_page_layout() is called.
BUILD_FINISHEDBuild of the page layout has finished. Fired once. This is the last event which occurs when Document.update_page_layout() is called.
CONVERSION_STARTEDConversion of document model to page layout has started. Fired once. This occurs when layout model starts pulling document content.
CONVERSION_FINISHEDConversion of document model to page layout has finished. Fired once. This occurs when layout model stops pulling document content.
REFLOW_STARTEDReflow of the page layout has started. Fired once. This occurs when layout model starts reflowing document content.
REFLOW_FINISHEDReflow of the page layout has finished. Fired once. This occurs when layout model stops reflowing document content.
PART_REFLOW_STARTEDReflow of the page has started. Note that page may reflow multiple times and that reflow may restart before it is finished.
PART_REFLOW_FINISHEDReflow of the page has finished. Note that page may reflow multiple times and that reflow may restart before it is finished.
PART_RENDERING_STARTEDRendering of page has started. This is fired once per page.
PART_RENDERING_FINISHEDRendering of page has finished. This is fired once per page.

See Also