comet.element

The element module provides factory functions for creating CElement objects.

Methods

comet.element.create(recordID: None | CIDType | tuple[int, int, int, str] = None, templateID: int = 0, formatString: str = '') → CElement

Create a new CElement object which is used in determining which elements to build for repeating element placeholders.

The element can be immediately initialized.

Parameters:

• recordID (None | CIDType | tuple[int, int, int, str]) –

  The record ID to immediately initialize the element with.
  
  The parameter type can be:

  • None

    Do not initialize the ID

  • CIDType

  • tuple [int, int, int, str]

    ID1, ID2, ID3, RecordStringID

• templateID (int) – The template ID to build the element with

• formatString (str) – The addional build information format string

Returns:

The newly created element

Return type:

CElement

Raises:

• TypeError – When parameter types are invalid

• CometError – On internal error

Available:

InDesign® comet_pdf®

CScript:

element::alloc

Examples:

Create an element.

myElement = comet.element.create((1, 0, 0, 'myElementID'), 100, 'type=area;post=autoload')