comet.CSpread

class comet.CSpread

A spread is a collection of pages belonging together.

Methods

CSpread.getDocument()

Get the document this spread belongs to.

Returns:

The document.

Return type:

CDocument

Raises:

CometError – On internal error

Available:

InDesign® comet_pdf®

CSpread.getPages()

Get all pages on this spread.

Returns:

All pages on this spread.

Return type:

list[CPage]

Raises:

CometError – On internal error

Available:

InDesign® comet_pdf®

CSpread.remove()

Remove this spread and all pages from the document it belongs to.

All subsequent calls to this spread’s functions will fail. This is also true for all CPage objects referencing pages from this spread.

At least one page has to remain in the document, so if this is the last spread this function will fail.

Return type:

None

Raises:

CometError – On internal error

Available:

InDesign® comet_pdf®

Special methods

CSpread.__repr__()

String representation.

Returns:

<CSpread> Index: Index | Pages: page count

Example

<CElement> 1, 2, 3, ABCD
Template ID: 123
Format string: type=area;post=autoload

Return type:

str