Changelog

The priint:comet Python API is now considered stable. This changelog will be removed in the future. All changes are now part of the main changelogs:

• priint:comet InDesign ®

• priint:comet_pdf

• priint:comet Illustrator ®

Legacy version history

This section contains all changes made during the beta phase by version to the priint:comet Python API. Each release can contain two sections:

Compatible changes

These changes extend functionality or fix errors and can generally be considered compatible with existing project implementations.

There is usually no need to change existing code for these changes to take effect.

Incompatible changes:

These changes require changes to existing project implementations or will generally cause existing scripts to fail or behave differently.

These changes usually are fixes to severe errors or restructuring of the priint:comet Python API.

R33520

Compatible changes

• New functions:

  • comet.inch2pt()

  • comet.pt2inch()

R33466

Compatible changes

• Fixes:

  • Cannot add arguments to comet.placeholder.loadServer (TW #2685384)

R33000

Compatible changes

• New modules:

  • progress

• New functions:

  • prefs.getShowURLProgress()

  • prefs.setShowURLProgress()

  • progress.start()

  • progress.step()

  • progress.stop()

R32862

Compatible changes

• New functions:

  • CDocument.getMetaData()

  • CDocument.setMetaData()

R32762

Compatible changes

• New functions:

  • placeholder.loadDataProvider()

• Fixes:

  • frame placeholder actions always error out with syntax errors.

  • placeholder actions error out when function variables are used which only have default values.

  • wlog() does not respect extened logging configuration.

R32735

Compatible changes

• Global variables from the Settings panel are now supported.

• New functions:

  • test.getDefaultDefinitionFile()

  • test.connect()

  • test.disconnect()

  • test.execute()

  • test.createProofs()

  • test.deleteProofs()

  • test.deleteResults()

  • test.assertion()

• Fixes:

  • frame.createTextFrame() parameter page is not considered default and must always be provided.

  • frame.createTextFrame() interprets page number wrongly.

  • placeholder.getTagValue() does not yield any valid result.

  • CPageItem.getPage() does not work for horizontal or vertical lines.

R32585

No changes

R32423

Compatible changes

• Loading product pool entries is now supported. All environment variables for the context kContextProductPoolEntries are now implemented.

• CFrame.setImage() now has an additional options parameter for selecting PDF pages and cropboxes when inserting a PDF

Incompatible changes

• placeholder.load() changed parameter name applyRules to applyLayoutRules

• CRect.moveTo() changed default value of parameter refPoint from comet.kRefPointCenter to comet.kRefPointTopLeft.

• CRect.adjust() changed default value of parameter refPoint from comet.kRefPointCenter to comet.kRefPointTopLeft.

• CRect.setWidth() changed default value of parameter refPoint from comet.kRefPointCenter to comet.kRefPointTopLeft.

• CRect.setHeight() changed default value of parameter refPoint from comet.kRefPointCenter to comet.kRefPointTopLeft.

R32286

Compatible changes

• comet.runCScript() now supports CIDType and list [CIDType] as input

• comet.runCScript() now supports CProduct and list [CProduct] as input

• comet.setScriptClipboard() now supports CIDType and list [CIDType]

• comet.setScriptClipboard() now supports CProduct and list [CProduct]

• CTextModel.setLeading() can now enable or disable automatic leading using the value parameter

• comet.setScriptClipboard() now has a parameter to automatically delete entries once no more scripts are on the stack

• New functions:

  • CTable.getFrame()

  • CSwatch.redefine()

  • CPageItem.getFillColor()

  • CPageItem.setFillColor()

• Fixes:

  • CSwatch.redefine() crashes when called more than once of the same swatch.

Incompatible changes

• CSwatch.redefine() parameter colors renamed to color

• CSwatch.redefine() parameter space has been removed - the space is now derived from the color parameter.

R32141

Compatible changes

• New functions:

  • CPageItem.getScale()

  • CPageItem.setScale()

  • CTextModel.getHorizontalJustification()

  • CTextModel.setHorizontalJustification()

• New constants:

  • Horizontal Justification

• The following functions have been moved from CFrame to CPageItem (should not interfere with usage):

  • CPageItem.moveTo()

• Fixes:

  • frame.createImageFrame() does not evaluate dimensions parameter.

  • product.get() does not work when using ‘selected’ as the statement.

  • comet.pyImport() sometimes fails with ModuleNotFoundError even though the module is there.

  • CPageItem.setScale() parameter refPoint is not considered a default parameter.

R32064

Compatible changes

• CometError now inherits Exception instead of BaseException, making it easier to catch

• New situations (see Availability):

  • Stamp action: kContextStampAction

  • Excel Query function script: kContextExcelQueryFunction

• Fixes:

  • comet.runCScript() crashes when parameter items is default.

  • CDocument.createPages() returns invalid objects after successful execution.

  • CFrame.duplicate() puts the result at inverted Y-coordinates for compound paths

  • CFrame.duplicate() does not properly place subpaths for compound paths

  • After calls to CPage.setPosition(), the page object is left in an invalid state.

  • Situation kContextLayoutRule is missing pubserver environment variables.

  • Situation kContextLayoutRuleCondition is missing pubserver environment variables.

  • Situation kContextLayoutRuleDynamicList is missing pubserver environment variables.

  • Situation kContextDoubleClickProductPool is missing pubserver environment variables.

R31940

Compatible changes

• CDocument.saveAs() and CDocument.saveAsCopy() now have an additional options parameter to configure saving options

• CFrame.duplicate() now accepts None for the x and y parameters, using the source coordinates if given

• Fixes:

  • situation kContextAfterLogin was not working for XML offline datapools

  • CFrame.duplicate() puts the result at inverted Y-coordinates

R31859

Compatible changes

• CDocument.getPage() now also accepts str as the data parameter to search for a page by name

• frame.getBBox() now accepts list [CPageItem] as input

• frame.getSelected() now returns list [CPageItem] instead of list [CFrame]

• frame.createTextFrame() now accepts coordinates directly as a tuple for the dimensions parameter

• frame.createTextFrame() now accepts [CLayer] and list [str] and int for the target layer

• frame.createTextFrame() now accepts [CPage] for the target page

• CPageItem.setLayer() can now use nested layers as the target layer

• CDocument.getLayer() can now search for nested layers and for layers by index

• New functions:

  • CTextModel.getTracking()

  • CTextModel.setTracking()

  • CTextModel.getLeading()

  • CTextModel.setLeading()

  • CLayer.getItems()

  • CPage.getBounds()

  • CPage.getPosition()

  • CPage.setPosition()

  • comet.isAltKeyPressed()

  • comet.isCtrlKeyPressed()

  • comet.isShiftKeyPressed()

  • comet.showError()

  • frame.createImageFrame()

• Fixes:

  • frame.createTextFrame() page parameter is not properly interpreted

  • CometError.getAdditionalInfo() raises when no additional information is available

  • CTable.getRowCount() parameter rowType does not have a default value

  • CTable.setStroke() does not work when operating on entire columns or rows

  • CPageItem.getType() was not implemented

  • CPageItem.setLayer() fails when the layer parameter is a nested CLayer

  • CDocument.exportPDF() does an undo after saving the document

  • CDocument.exportPDF() does not evaluate the indices parameter

Incompatible changes

• frame.createTextFrame() parameter order changed

• frame.getBBox() parameter frames has been renamed to items

• CDocument.getLayer() parameter name has been renamed to data

R31755

No changes

R31701

Compatible changes

• product.establish() now additionally accepts a page index for the page parameter

• comet.pyImport() can now handle all imports like CScript

• CTable.setCellFill() now also accepts CColor as the data parameter

• New modules:

  • xmltree

• New classes:

  • CXMLNode

  • CXMLTree

• New functions:

  • prefs.getLogState()

  • prefs.setLogState()

  • product.getEstablished()

  • CPage.createSnapshot()

  • CBook.getDocumentPageRange()

  • CTable.cellHasOverset()

  • CXMLNode.getName()

  • CXMLNode.getType()

  • CXMLNode.getPath()

  • CXMLNode.getContent()

  • CXMLNode.getChildren()

  • CXMLNode.isAttribute()

  • CXMLTree.getRoot()

  • CXMLTree.send()

  • CXMLTree.sendCDataBegin()

  • CXMLTree.sendCDataEnd()

  • CXMLTree.input()

  • CXMLTree.output()

  • CXMLTree.execute()

  • CXMLTree.fetch()

  • CXMLTree.serialize()

• Fixes:

  • Error messages of exceptions do not get output to the logfile when custom logging (log.xml) is enabled

  • product.establish() does not accept CPage as the page parameter

  • link.insertTocEntry() crashes when parameter options is not given

  • comet.pyImport() does not always raise an ImportError when the import failed

  • hyperlink.create() raises CometError on creation of text hyperlinks

  • placeholder.load() only works properly when parameter recordIDs is not empty

  • rect.create() parameters top and right are reversed

  • hyperlink.findCrossRefs() parameter calcTextCoords does not work

  • CCrossRef.getPageIndex() parameter fromBook is not default

  • CCrossRef.getPageName() parameter fromBook is not default

  • CBook.setDocumentPosition() does not raise KeyError when the document is not found

  • CBook.setMasterDocument() does not raise KeyError when the document is not found

  • CBook.removeDocument() does not raise KeyError when the document is not found

  • CBook.removeDocument() reports wrong function name on error

  • CTable.setCellFill() raises TypeError when the data parameter is a tuple

  • CTable.getCellType() always raises CometError

  • CTable.remove() always raises CometError

  • CTable.getCellStyle() always raises CometError

  • CTable.setCellStyle() always raises CometError

  • CTable.getCellInsets() always raises CometError

  • CTable.setCellInsets() always raises CometError

  • CTable.getCellFrame() always raises CometError

  • CTable.getCellBox() always raises CometError

  • CTable.getCellSize() always raises CometError

  • CTable.getCellText() always raises CometError

  • CTable.setStroke() always raises CometError

  • CTable.setCellFill() always raises CometError

  • CTable.setCellText() always raises CometError

  • CTable.mergeCells() always raises CometError

  • CTable.getStyle() always raises CometError

  • CTable.setStyle() always raises CometError

  • CTable.getColumnWidth() always raises CometError

  • CTable.getColumnWidth() always raises CometError

  • CTable.getRowHeight() always raises CometError

  • CTable.setRowHeight() always raises CometError

  • CTable.insertColumns() always raises CometError

  • CTable.removeColumns() always raises CometError

  • CTable.getColumnCount() always raises CometError

  • CTable.insertRows() always raises CometError

  • CTable.removeRows() always raises CometError

  • CTable.getRowCount() always raises CometError

  • CTable.getFrame() always raises CometError

Incompatible changes

• comet.runCScript() items parameter completely reworked to support a wide range of Python types in CScript

• CFrame.getTemplate() now has an additional parameter whether to determine the template name

• CPage.snapshot() has been removed

• CFrame.getHasOverset() is now CFrame.hasOverset()

• comet.pyImport() now always requires a file extension when trying to import a file

R31400

Compatible changes

• Fixes:

  • CPageItem.getOpacity() always raises an error in InDesign®

R31313

Compatible changes

• Fixes:

  • The following functions always raise an exception stating the textmodel could not be found:

    • CFrame.getTextModel()

    • CFrame.getColumnGutter()

    • CFrame.setColumnGutter()

    • CFrame.getText()

    • CFrame.setText()

    • CFrame.getColumnCount()

R31147

Compatible changes

• Fixes:

  • Fixed an issue on Mac systems where sometimes int parameters would not be properly filled

R30871

Compatible changes

• New situations (see Availability):

  • app.comet.eval (Call from Javascript): kContextServerInterface

  • URLLink header data: kContextURLLinkHeaderData

• New functions:

  • datapool.getSessionID()

  • frame.createGroup()

  • CFrame.applyLayoutRules()

  • CFrame.getPageElement()

  • CFrame.getTemplate()

  • CometError.__str__()

  • CometError.getAdditionalInfo()

  • CPage.getInfo()

  • CPage.setInfo()

  • CPage.getPageItems()

  • CPageItem.removeScriptTags()

• New constants:

  • Page info

• The following functions have been moved from CFrame to CPageItem (should not interfere with usage):

  • CPageItem.getBBox()

  • CPageItem.getScale()

  • CPageItem.setScale()

  • CPageItem.getRotation()

  • CPageItem.setRotation()

  • CPageItem.getSkew()

  • CPageItem.setSkew()

  • CPageItem.getPrintable()

  • CPageItem.setPrintable()

  • CPageItem.getOverprint()

  • CPageItem.setOverprint()

  • CPageItem.getObjectStyle()

  • CPageItem.setObjectStyle()

  • CPageItem.getScriptTag()

  • CPageItem.getScriptTags()

  • CPageItem.setScriptTag()

• Fixes:

  • Text layout rules cause a crash on execution

  • hyperlink.findCrossRefs() is not working

  • CDocument.getPage() parameter data is evaluated wrongly

  • CPage.getFrames() yields frames of entire spread and sometimes nothing

Incompatible changes

• The function CFrame.getIsInFront() is now CFrame.isInFront()

• The function CFrame.getIsInBack() is now CFrame.isInBack()

• The function CSwatch.getIsSpot() is now CSwatch.isSpot()

• The function CSwatch.getIsLocked() is now CSwatch.isLocked()

• The function CSwatch.getIsReserved() is now CSwatch.isReserved()

R30779

Compatible changes

• New classes:

  • CGroup

  • CPageItem

• New functions:

  • comet.getScriptClipboard()

  • comet.setScriptClipboard()

  • comet.clearScriptClipboard()

  • frame.getSelected()

  • html.toTagged()

  • html.exportText()

  • link.insertTocEntry()

  • link.deleteTocEntry()

  • publication.getProductPlanning()

  • CBook.exportPDF()

  • CFrame.getNail()

  • CFrame.setNail()

  • CFrame.applyMagnets()

  • CGroup.getMembers()

  • CGroup.addMembers()

  • CGroup.removeMembers()

  • CGroup.getGroup()

  • CGroup.resolve()

  • CDocument.getGroups()

  • CDocument.getPageItems()

  • CDocument.setStartPage()

  • CDocument.saveAsCopy()

  • CLink.getPrefix()

  • CLink.getPrefixIfEmpty()

  • CLink.getPostfix()

  • CLink.getPostfixIfEmpty()

• Other new things:

  • The documentation stubs (found in PyDoc/comet) now more accurately reflect the actual class and module structure of comet.

    All classes are now properly members of the comet module instead of a seperate module per class.

  • CFrame now inherits CPageItem

    The following functions have been moved from CFrame to CPageItem (should not interfere with usage):

    • CPageItem.getUID()

    • CPageItem.getType()

    • CPageItem.getDocument()

    • CPageItem.getPage()

    • CPageItem.getLayer()

    • CPageItem.setLayer()

    • CPageItem.getGroup()

    • CPageItem.getName()

    • CPageItem.setName()

    • CPageItem.getLocked()

    • CPageItem.setLocked()

    • CPageItem.getVisible()

    • CPageItem.setVisible()

    • CPageItem.remove()

  • Designate constants

  • Pageitem types new value comet.kPageItemTypeGuide (used with CPageItem.getType())

  • Pageitem types new value comet.kPageItemTypeQRCode (used with CPageItem.getType())

  • product.establish() provides a more verbose error message when parameter products is empty list

  • CDocument.exportPDF() now accepts an empty path parameter, putting the result PDF next to the document

  • CDocument.exportPDF() now respects the scope parameter

  • CDocument.exportPDF() now respects the indices parameter

  • CDocument.exportPDF() now accepts a dict as the profile parameter containing interactive PDF options

• Fixes:

  • CDocument.exportPDF() always crashes

  • CTable.getCellSize(), CTable.getCellTextPosition(), CTable.getCellBox(), CTable.getCellFrame(), CTable.getCellInsets(), and CTable.getCellStyle() don’t accept out of bounds indices even though they should

  • product.establish() parameter layer does not work when explicitly providing None as value

Incompatible changes

• Other changes:

  • comet.FrameTypes is now Pageitem types

  • CFrame.hasOverset() is now CFrame.getHasOverset()

  • CFrame.isInline() is now CFrame.getIsInline()

  • CDocument.getCellSize() parameter insetRelative renamed to areaType, type changed from bool to int

  • CDocument.getCellBox() parameter relativeTo renamed to areaType, valid value range changed

  • print() is no longer redirected to the comet logfile since that causes crashes on M1 Macs

R30683

Compatible changes

• Python version has been upgraded to 3.10

• New classes:

  • CBookmark

  • CColor

  • CCrossRef

• New functions:

  • color.createGray()

  • color.createRGB()

  • color.createCMYK()

  • color.createLAB()

  • hyperlink.findCrossRefs()

  • CBookmark.isValid()

  • CBookmark.getDocument()

  • CBookmark.getName()

  • CBookmark.setName()

  • CBookmark.getDepth()

  • CBookmark.getIndex()

  • CBookmark.setIndex()

  • CBookmark.getParent()

  • CBookmark.setParent()

  • CBookmark.getChildren()

  • CBookmark.setColor()

  • CBookmark.createBookmark()

  • CBookmark.remove()

  • CColor.getModel()

  • CColor.getValues()

  • CColor.setGray()

  • CColor.setRGB()

  • CColor.setCMYK()

  • CColor.setLAB()

  • CCrossRef.getName()

  • CCrossRef.getDocumentName()

  • CCrossRef.getDocumentPath()

  • CCrossRef.getPageIndex()

  • CCrossRef.getPageName()

  • CCrossRef.getDestination()

  • CCrossRef.getPosition()

  • CCrossRef.getFrameBBox()

  • CCrossRef.getIndex()

  • CCrossRef.getFrame()

  • CDocument.getBook()

  • CDocument.getFrame()

  • CDocument.getSwatch()

  • CDocument.getSwatches()

  • CDocument.createSwatchRGB()

  • CDocument.createSwatchCMYK()

  • CDocument.createSwatchLAB()

  • CDocument.getBookmarks()

  • CDocument.createBookmark()

  • CDocument.createPages()

  • CSwatch.getModel()

  • CSwatch.getColor()

  • CTextModel.insertCrossRef()

• Other new things:

  • CTextModel.setColor() now also accepts CColor for the color parameter

  • CHyperlink.setColor() now also accepts CColor for the color parameter

  • Color models constants

  • Swatch spaces constants

• Fixes:

  • Several memory leaks

  • document.open() always raises a CometError

Incompatible changes

• Removals:

  • comet.DocColorModels constants (replaced by Color models)

  • comet.ColorTypes constants (replaced by Swatch spaces)

  • page module removed - was not functional

  • frame.find() (replaced by CDocument.getFrame())

  • color.getSwatch() (replaced by CDocument.getSwatch())

  • color.getSwatches() (replaced by CDocument.getSwatches())

  • color.createSwatchRGB() (replaced by CDocument.createSwatchRGB())

  • color.createSwatchCMYK() (replaced by CDocument.createSwatchCMYK())

  • color.createSwatchLAB() (replaced by CDocument.createSwatchLAB())

• Other changes:

  • All Python scripts must now start with the #!py directive at beginning of the script.

    Before, this directive could be anywhere in the script.

    See here: Hello world!

  • color : Several functions now have uppercase parameter names for the color values

  • CExcelBook.getFontColor() now returns CColor instead of color values tuple

  • CExcelBook.getColor() now returns CColor instead of color values tuple

  • CTextModel.getColor() now returns CColor instead of color values tuple

  • CTextModel.getColor() no longer returns color model individually - it is contained in the result CColor

  • CDocument.addLayer() renamed to CDocument.createLayer()

R30603

Compatible changes

• New classes:

  • CCometGroup

• New functions:

  • color.createSwatchRGB()

  • color.createSwatchCMYK()

  • hyperlink.find()

  • prefs.getSnippetMatch()

  • prefs.setSnippetMatch()

  • CBook.getDocuments()

  • CCometGroup.getDocument()

  • CCometGroup.getID()

  • CCometGroup.getMembers()

  • CCometGroup.addMembers()

  • CCometGroup.removeMembers()

  • CCometGroup.remove()

  • CDocument.getCometGroup()

  • CDocument.getPage()

  • CDocument.getLayer()

  • CFrame.getChainFrames()

  • CFrame.getCometGroup()

  • CLayer.getPath()

  • CLayer.getParent()

  • CLayer.setParent()

  • CLayer.getChildren()

  • CLayer.getSiblings()

  • CSwatch.getDocument()

  • CSwatch.getName()

  • CTextModel.getInlines()

• Other new things:

  • New environment variables gDocumentPathPDF and gBeforeMetaData in kContextDocWatch

  • Constants Snippet match settings

  • New parameter for prefs.getURLLinkTimeout() and prefs.setURLLinkTimeout() which determines the type of timeout

• Fixes:

  • CPage objects pointing to the same page should now properly update on changes

Incompatible changes

• Removals

  • frame.resolveCometGroup()

  • frame.getCometGroupMembers()

• Other changes

  • CTable.colorize() is now named CTable.setCellFill()

  • CTable.setCellFill() parameters refactored

  • frame.define() is now named frame.find()

  • CDocument.getFrames() parameters fully refactored

R30464

Compatible changes

• New modules:

  • book

  • hyperlink

• New classes:

  • CBook

  • CHyperlink

  • CHyperlinkSource

  • CHyperlinkDestination

• New functions:

  • frame.define()

  • book.create()

  • book.open()

  • book.getOpen()

  • book.getByPath()

  • book.getCurrent()

  • hyperlink.createPageDestination()

  • hyperlink.createTextDestination()

  • hyperlink.createURLDestination()

  • hyperlink.create()

  • hyperlink.getNextUniqueKey()

  • CBook.isValid()

  • CBook.getPath()

  • CBook.save()

  • CBook.close()

  • CBook.setCurrent()

  • CBook.insertDocument()

  • CBook.removeDocument()

  • CBook.getDocumentPosition()

  • CBook.setDocumentPosition()

  • CBook.getMasterDocument()

  • CBook.setMasterDocument()

  • CBook.repaginate()

  • CLayer.getFrames()

  • CHyperlink.isValid()

  • CHyperlink.getType()

  • CHyperlink.getDocument()

  • CHyperlink.getSource()

  • CHyperlink.getDestination()

  • CHyperlink.getName()

  • CHyperlink.setName()

  • CHyperlink.getVisible()

  • CHyperlink.setVisible()

  • CHyperlink.getColor()

  • CHyperlink.setColor()

  • CHyperlink.getBorderWidth()

  • CHyperlink.setBorderWidth()

  • CHyperlink.getHilight()

  • CHyperlink.setHilight()

  • CHyperlink.getOutlineStyle()

  • CHyperlink.setOutlineStyle()

  • CHyperlink.remove()

  • CHyperlinkSource.isValid()

  • CHyperlinkSource.getDocument()

  • CHyperlinkSource.getType()

  • CHyperlinkSource.getFrame()

  • CHyperlinkSource.getTextModel()

  • CHyperlinkSource.getStart()

  • CHyperlinkSource.getLength()

  • CHyperlinkSource.getLink()

  • CHyperlinkDestination.isValid()

  • CHyperlinkDestination.getDocument()

  • CHyperlinkDestination.getType()

  • CHyperlinkDestination.getPageIndex()

  • CHyperlinkDestination.getURL()

  • CHyperlinkDestination.getTextAnchor()

  • CTextModel.setColor()

  • CTextModel.getColor()

• Other new things:

  • CPage.setSize() new default parameter ‘refPoint’

  • CRect.adjust() new default parameter ‘refPoint’

  • CRect.setHeight() new default parameter ‘refPoint’

  • CRect.setWidth() new default parameter ‘refPoint’

  • CRect.moveTo() new default parameter ‘refPoint’

Incompatible changes

• Other new things

  • CTextModel.setFontSize() parameter order changed

  • CTextModel.setFont() parameter order changed

  • CTextModel.setColor() parameter order changed

  • CTextModel.setParaStyle() parameter order changed

  • CTextModel.setCharStyle() parameter order changed

  • CTextModel.getParaStyle() result tuple value order changed

  • CTextModel.getCharStyle() result tuple value order changed

  • CTextModel.getFontSize() returns tuple instead of float

R30323

Compatible changes

• New situations (see Availability):

  • Page template after apply

• New modules:

  • logger for advanced logfile writing

  • color for access to document colors and swatches

• New classes:

  • CSwatch

• New functions:

  • logger.log()

  • logger.error()

  • logger.warning()

  • logger.info()

  • logger.debug()

  • logger.trace()

  • logger.getPattern()

  • logger.setPattern()

  • logger.getEscaping()

  • logger.setEscaping()

  • logger.getPath()

  • logger.setPath()

  • logger.getLevel()

  • logger.setLevel()

  • logger.reloadConfig()

  • color.createSwatchRGB()

  • color.createSwatchCMYK()

  • color.createSwatchLAB()

  • color.getSwatch()

  • color.getSwatches()

  • product.getBuildTrace()

  • product.setBuildTrace()

  • CDocument.getAttributes()

  • CSwatch.getDocument()

  • CSwatch.getName()

  • CSwatch.getSpace()

  • CSwatch.getType()

  • CSwatch.getTint()

  • CSwatch.getIsSpot()

  • CSwatch.getIsLocked()

  • CSwatch.getIsReserved()

  • CSwatch.getColors()

  • CSwatch.redefine()

  • CTable.setCellInsets()

  • CTable.getCellType()

  • CFrame.getOverprint()

  • CFrame.setOverprint()

  • CFrame.setName()

  • CFrame.getScale()

  • CFrame.setScale()

  • CFrame.getSkew()

  • CFrame.setSkew()

  • CFrame.setPrintable()

  • CFrame.getPrintable()

  • CFrame.getColumnCount()

  • CFrame.setColumnCount()

  • CFrame.getColumnGutter()

  • CFrame.setColumnGutter()

  • CFrame.getImageSkew()

  • CFrame.setImageSkew()

• Other new things:

  • Context comet.kContextPageTemplateAfterApply

  • Constants Swatch types

  • Constants comet.ColorTypes

  • Constants Overprint settings

  • Sides value comet.kSideAll

Incompatible changes

• CDocument.hasAttribute() removed for now. May be reintroduced later.

• CExcelBook.getCellFormat() now returns tuple instead of list

• CTable.setText() is now named CTable.setCellText()

R30121

Compatible changes

• New situations (see Availability):

  • Product build: Prescript

  • Previews panel entries

• New functions:

  • product.create()

  • CFrame.duplicate()

  • CProduct.setAttribute()

• Other new things:

  • New context comet.kContextProductBuildPre

  • New context comet.kContextPreviewsEntries

  • New context comet.kContextPreviewsLink

  • Environment variable gProducts is now available for kContextProductBuildPre

R30009

Compatible changes

• New situations (see Availability):

  • Table Module: Insert rows

  • Table Module: Insert columns

  • Table module: Layout rules

  • Table Module: Cell ID

  • ToDoList: Custom tasks

  • Placeholder sync: String comparison

  • Product pool: Default search field value

• New functions:

  • Added product.establish()

  • Added prefs.getMagnetState()

  • Added prefs.setMagnetState()

  • Added prefs.getLayoutRulesState()

  • Added prefs.setLayoutRulesState()

  • Added prefs.getLayoutRuleState()

  • Added prefs.setLayoutRuleState()

• Other new things:

  • Added new context comet.kContextTableModuleInsertRow

  • Added new context comet.kContextTableModuleInsertColumn

  • Added new context comet.kContextTableModuleLayoutRule

  • Added new context comet.kContextTableModuleCellID

  • Added new context comet.kContextToDoListCustomTask

  • Added new context comet.kContextPlaceHolderStringCompare

  • Added new context comet.kContextProductPoolSFDefaultValue

  • Added Magnet situations constants and dictionary

  • Added Magnet states constants and dictionary

R29607

Compatible changes

• Several modules and their static functions have been reinstituted

• New modules:

  • Added host module for querying the host environment the priint:comet Python API is running in

    • Added host.getType()

    • Added host.getVersion()

    • Added host.getIsServer()

    • Added host.getLanguage()

    • Added host.getApplicationPath()

    • Added host.getPluginPath()

    • Added host.getPDFProfileNames()

    • Added host.exportPDFProfiles()

    • Added host.importPDFProfiles()

    • Added host.getPrintProfileNames()

    • Added host.exportPrintProfiles()

    • Added host.importPrintProfiles()

    • Added host.getFlattenerProfileNames()

    • Added host.exportFlattenerProfiles()

    • Added host.importFlattenerProfiles()

• New functions:

  • Added comet.getVersion()

  • Added comet.getRevision()

  • Added page.create()

  • Added placeholder.loadServer()

  • Added CTextModel.replace()

• Other new things:

  • Added Excel cell types constants and dictionary

  • Added Excel selectors constants and dictionary

  • Added Excel border styles constants and dictionary

  • Added Excel underline styles constants and dictionary

  • Added Excel font positions constants and dictionary

Incompatible changes

• Removed all constants from excel module and moved them to comet module

• Removed comet.getHost() (moved to host.getType())

• Removed sync module. Functionality can be achieved using comet.setOutput()

• Removed system module (moved functions to comet and host):

  • Removed system.getApplicationPath()

  • Removed system.getPluginPath()

  • Removed system.getRevision()

  • Removed system.getCometVersion()

• Static functions in classes have been removed again and moved to their appropriate modules

• Moved comet.selectFile() to dialog.selectFile()

• Moved comet.selectFolder() to dialog.selectFolder()

R29546

Compatible changes

• Python can now be used in the following additional situations (see Availability):

  • Text layout rules

  • Text layout conditions

  • Panel actions: Previews

  • Panel actions: ToDo list

  • Comet notes: Target layer

  • Comet notes: Parastyle

  • Products of document: Special cases

• New functions:

  • Added comet.selectFolder()

  • Added comet.getKeyValue()

  • Added publication.toXMLStringList()

  • Added publication.fromXMLStringList()

  • Added publication.toXMLFloatList()

  • Added publication.fromXMLFloatList()

  • Added publication.toXMLIntList()

  • Added publication.fromXMLIntList()

  • Added publication.toXMLKeyValueList()

  • Added publication.fromXMLKeyValueList()

  • Added publication.toXMLElement()

  • Added publication.fromXMLElement()

  • Added publication.toXMLElementList()

  • Added publication.fromXMLElementList()

  • Added publication.toXMLIDType()

  • Added publication.fromXMLIDType()

  • Added publication.toXMLIDTypeList()

  • Added publication.fromXMLIDTypeList()

  • Added publication.toXMLParameter()

  • Added publication.fromXMLParameter()

  • Added publication.toXMLParameterList()

  • Added publication.fromXMLParameterList()

  • Added publication.toXMLPlanning()

  • Added publication.fromXMLPlanning()

  • Added publication.toXMLPlanningList()

  • Added publication.fromXMLPlanningList()

  • Added publication.toXMLProduct()

  • Added publication.fromXMLProduct()

  • Added publication.toXMLProductList()

  • Added publication.fromXMLProductList()

  • Added publication.toXMLPublication()

  • Added publication.fromXMLPublication()

  • Added publication.toXMLPublicationList()

  • Added publication.fromXMLPublicationList()

  • Added publication.toXMLPublicationType()

  • Added publication.fromXMLPublicationType()

  • Added publication.toXMLPublicationTypeList()

  • Added publication.fromXMLPublicationTypeList()

  • Added publication.toXMLWorkflowStatus()

  • Added publication.fromXMLWorkflowStatus()

  • Added publication.toXMLWorkflowStatusList()

  • Added publication.fromXMLWorkflowStatusList()

  • Added CTable.create()

  • Added CTable.find()

• Other new things:

  • Added Basic types dictionary

  • Added Contexts dictionary

  • Added Indices dictionary

  • Added Line types dictionary

  • Added Row types dictionary

  • Added Stroke selectors dictionary

  • Added Stroke attributes dictionary

  • Added Stroke types dictionary

  • Added Text formats dictionary

  • Added an Examples section

  • Added new context comet.kContextNoteParastyle

  • Added new context comet.kContextNoteTargetLayer

  • Added new context comet.kContextPODSpecialCases

Incompatible changes

• Removed constants from table module. Replaced by constants in comet module, e.g. Row types

• The following modules are deprecated and will be removed (already gone from documentation): dialog, document, element, idtype, layoutrule, link, page, product, rect, table .

  All functionality is now moved to static functions in the appropriate classes

• comet.setGlobal is now named comet.setOutput()

• Removed CParameter.getAll()

• Removed CParameter.get()

• Removed CParameter.createFromXML()

• Removed CParameter.toXML()

• Removed CPlanning.createFromXML()

• Removed CPlanning.toXML()

• Removed CPublication.get()

• Removed CPublication.createFromXML()

• Removed CPublication.toXML()

• Removed CPublicationType.getAll()

• Removed CPublicationType.createFromXML()

• Removed CPublicationType.toXML()

• Removed CWorkflowStatus.getAll()

• Removed CWorkflowStatus.get()

• Removed CWorkflowStatus.getAvailable()

• Removed CWorkflowStatus.createFromXML()

• Removed CWorkflowStatus.toXML()

R29355

Compatible changes

• A lot of refactoring has been done in moving module functions from their module to static class functions.

• New Modules:

  • Added publication module for querying priint:suite publication information

    • Added publication.getPublications()

    • Added publication.getAllParameters()

    • Added publication.getAllPublicationTypes()

    • Added publication.getAllWorkflowStates()

    • Added publication.getParameters()

    • Added publication.getWorkflowStates()

    • Added publication.getWorkflowStatus()

• New Classes:

  • Added CParameter

    • Added CParameter.createFromXML()

    • Added CParameter.getValue()

    • Added CParameter.toXML()

  • Added CPlanning

    • Added CPlanning.createFromXML()

    • Added CPlanning.getValue()

    • Added CPlanning.toXML()

  • Added CPublication

    • Added CPublication.createFromXML()

    • Added CPublication.getValue()

    • Added CPublication.toXML()

  • Added CPublicationType

    • Added CPublicationType.createFromXML()

    • Added CPublicationType.getValue()

    • Added CPublicationType.toXML()

  • Added CWorkflowStatus

    • Added CWorkflowStatus.createFromXML()

    • Added CWorkflowStatus.getValue()

    • Added CWorkflowStatus.toXML()

• New Functions:

  • Added CDocument.getFront()

  • Added CDocument.open()

  • Added CDocument.getOpen()

  • Added CDocument.getRasterEffectResolution()

  • Added CDocument.getColorModel()

  • Added CDocument.getColorProfile()

  • Added CDocument.setColorProfile()

  • Added CDialog.create()

  • Added CElement.create()

  • Added CIDType.create()

  • Added CLink.collect()

  • Added CRect.create()

  • Added CRect.createSquare()

• Other new things:

  • Added Publication selectors constants and descriptions for querying publication class information

  • Added Document close modes constants for closing documents in InDesign®

  • Added comet.DocColorModels constants for querying the document color model for Illustrator®

  • Added Link sorting constants

  • Added Link first selectors constants

  • Added comet.kFrameTypeGroup, comet.kFrameTypeLegacyText and comet.kFrameTypeGraph which can be returned from CFrame.getType()

• Fixes:

  • Fixed comet.sync.setNewValue and setOldValue not working

  • Fixed CDocument.exportPDF not working

  • Fixed a crash involving CProduct instances

  • Fixed product.get not working

  • Fixed page.snapshot() not parsing parameters correctly

Incompatible changes

• Removed link sorting constants from idtype module. Replaced by Link sorting

• Removed first link selector constants from idtype module. Replaced by Link first selectors

R29302

Compatible changes

• Documentation restructuring (Moved several articles from Usage to Introduction)

• Python can now be used in the following additional situations (see Availability):

  • Template panel actions

• Running other script types from Python now provides limited environment variable inheritance.

  See Calling other scripts

• New Functions:

  • Added comet.selectFile()

  • Added placeholder.load()

  • Added placeholder.store()

  • Added placeholder.build()

  • Added CDocument.setFront()

  • Added CDocument.close()

  • Added CFrame.getScriptTag()

• CTextModel.getFont() now also returns the run length

• document.open() now has an appendToRecent parameter

• Fixed CDocument.setAttribute() crashing

• Fixed CFrame.moveTo() not working properly with moved artboards

R29218

Compatible changes

• All parameters for any functions are now keyword parameters

• New Modules:

  • Added system module which provides general comet environment information

    • Added system.getApplicationPath()

    • Added system.getPluginPath()

    • Added system.getRevision()

    • Added system.getCometVersion()

  • Added datapool module which provides connection access for the comet data pool

    • Added datapool.getConnection()

    • Added datapool.loginSOAP()

    • Added datapool.loginDB()

    • Added datapool.loginXML()

    • Added datapool.logout()

• New Classes:

  • Added CSOAP class for SOAP connections

    • Added CSOAP.getServer()

    • Added CSOAP.getUser()

    • Added CSOAP.getLanguage()

    • Added CSOAP.getClient()

    • Added CSOAP.getCharset()

    • Added CSOAP.uploadFile()

    • Added CSOAP.uploadData()

    • Added CSOAP.uploadFolder()

    • Added CSOAP.download()

    • Added CSOAP.createQuery()

  • Added CSQL class for SQL connections

    • Added CSQL.getServer()

    • Added CSQL.getUser()

    • Added CSQL.getDBName()

    • Added CSQL.getClient()

    • Added CSQL.getCharset()

    • Added CSQL.createQuery()

  • Added CQuery class for SQL/SOAP queries

    • Added CQuery.send()

    • Added CQuery.input()

    • Added CQuery.output()

    • Added CQuery.execute()

    • Added CQuery.fetch()

    • Added CQuery.commit()

    • Added CQuery.rollback()

    • Added CQuery.getCommand()

    • Added CQuery.getParent()

• New Functions:

  • Added comet.runJavaScript()

  • Added comet.runCScript()

  • Added prefs.getTagsReadable()

  • Added prefs.setTagsReadable()

  • Added prefs.getURLLinkTimeout()

  • Added prefs.setURLLinkTimeout()

  • Added prefs.getURLLinkFolder()

  • Added prefs.setURLLinkFolder()

  • Added prefs.getUpdateType()

  • Added prefs.setUpdateType()

  • Added prefs.getUpdatePath()

  • Added prefs.setUpdatePath()

  • Added prefs.getDocWatch()

  • Added prefs.setDocWatch()

  • Added CDocument.getDisplayName()

  • Added CDocument.setDisplayName()

  • Added CPage.getUID()

  • Added CPage.setIndex()

  • Added CPage.remove()

  • Added CTable.getUID()

  • Added CTable.removeRows()

  • Added CTable.removeColumns()

• Other new things:

  • Added Sides constants dictionary

  • Added List types constants dictionary

  • Added comet.FrameTypes constants dictionary

  • Added Host environments constants dictionary

  • Added Link types constants dictionary

• Fixed CRect.setBottom() setting the wrong value

• Fixed CTextModel.setCharStyle() expecting wrong parameter types

• Fixed CTextModel.setParaStyle() expecting wrong parameter types

Incompatible changes

• CExcelBook.getFontColor() now returns a tuple instead of a list

R29068

Compatible changes

• Python can now be used in the following additional situations (see Availability):

  • URL Drop action ID

  • URL Drop

  • Build support

  • Alternative templates

• All CFrame functions now do improved self checking whether the frame is still valid in the document, e.g. after deleting a frame

• Multiple CTable functions now properly justify out of bounds column and row indices.

• Functions of frame which require a document now accept None to use the current script document.

• New Functions:

  • frame.createCometGroup()

  • frame.resolveCometGroup()

  • placeholder.set()

  • placeholder.link()

  • placeholder.setTagValue()

  • prefs.getCScriptBuffer()

  • prefs.setCScriptBuffer()

  • CFrame.isValid()

  • CFrame.remove()

  • CFrame.getSmartItemData()

  • CFrame.setSmartItemData()

  • CFrame.getZOrder()

  • CFrame.moveForward()

  • CFrame.moveBackward()

  • CFrame.moveToFront()

  • CFrame.moveToBack()

  • CFrame.getIsInFront()

  • CFrame.getIsInBack()

  • CFrame.setCometGroupID()

  • CTable.remove()

  • CTable.getTextPosition()

  • CTable.getAnchorPosition()

  • CTable.getCellText()

  • CTable.getCellTextPosition()

  • CTable.getCellBox()

  • CTable.getCellFrame()

  • CTable.getCellInsets()

  • CTextModel.getFrame()

• Other new things:

  • New context: comet.kContextURLDropActionID

  • New context: comet.kContextURLDrop

  • New context: comet.kContextBuildSupport

  • New context: comet.kContextAlternativeTemplate

  • New context: comet.kContextTableModuleRecordID

  • New context: comet.kContextPublicationCheckout

  • New context: comet.kContextPublicationAfterSave

  • New context: comet.kContextPublicationBeforeClose

  • New context: comet.kContextPublicationStatus

  • New context: comet.kContextPublicationCheckin

  • New context: comet.kContextPublicationAfterClose

  • New context: comet.kContextPublicationRevert

  • New context: comet.kContextPublicationAfterCheckout

  • New build situation constants to comet module. See Build situations

• Fixed link.collect() pages parameter not working

• Fixed CFrame.setScriptTag() parameters key and value being swapped

• Fixed CFrame.setScriptTag() putting strings in quotes

• Fixed CFrame.setLayer() layer parameter being wrongfully optional

Incompatible changes

• frame.createTextFrame() now uses a 0-based index for the page instead of 1 based

R28940

Compatible changes

• Python can now be used in the following additional situations (see Availability):

  • Layout rule dynamic parameter value lists

  • Layout rule dynamic definition

  • Table function variable parameter value lists

  • Table function variable dynamic definition

  • DocWatch

  • Comet Tests

  • URLLink Destination folder

• We added a new output variable mechanism for writing to global variables depending on context. See Output variables and comet.setGlobal()

• New Modules:

  • Added placeholder module which contains placeholder action context relative functions:

    • Added placeholder.getTagValue()

  • Added html module which contains HTML utility functions

    • Added html.getRawText()

  • Added element module which contains factory functions for repeating element placeholders

    • Added element.create()

• New Classes:

  • Added CElement class for repeating elements

    • Added CElement.getID()

    • Added CElement.setID()

    • Added CElement.getTemplateID()

    • Added CElement.setTemplateID()

    • Added CElement.getClassID()

    • Added CElement.setClassID()

    • Added CElement.getFormatString()

    • Added CElement.setFormatString()

    • Added CElement.getMasterFrame()

    • Added CElement.getFrames()

    • Added CElement.getOrderNumber()

• New Functions:

  • Added frame.getCometGroupMembers()

  • Added sync.getSyncState()

  • Added sync.setSyncState()

  • Added CLayer.setIndex()

  • Added CLayer.remove()

  • Added CFrame.getUID()

  • Added CFrame.getBuiltElements()

• Other new things:

  • Added Sync states constants to comet module

  • Added new context: comet.kContextDocWatch

  • Added new context: comet.kContextURLLinkDestFolder

• Fixes:

  • Fixed CDocument.getMasterPageInfo() returning double prefixed names

  • Fixed CDocument.getBleed() always raising SystemError

  • Fixed link.collect() sort parameter not working

  • Fixed idtype module being unavailable

  • Fixed the following class instances not being properly checked for equality using the == operator:

    • CDialog

    • CDocument

    • CExcelBook

    • CFrame

    • CIDType

    • CLayer

    • CLink

    • CPage

    • CRect

    • CTable

    • CTextModel

Incompatible changes

• Renamed module layoutRule to layoutrule (lower case r)

• Moved Link types constants from CLink to comet module

R28889

Compatible changes

• Added frame.getBBox()

• Added frame.moveTo()

• Added CDocument.addLayer() (was not implemented)

• Added CDocument.getLayers() (was not implemented)

• Added CDocument.getDefaultLayerName()

• Added CDocument.getCurrentPage()

• Added CDocument.getMasterPageInfo()

• Added CFrame.getCometGroupID()

• Added CFrame.getDocument()

• Added CFrame.getImagePosition()

• Added CFrame.getName()

• Added CFrame.fitImage()

• Added CFrame.getImageSize()

• Added CFrame.setImageSize()

• Added CFrame.setImagePosition()

• Added CFrame.getImageScale()

• Added CFrame.setImageScale()

• Added CFrame.getImageRotation()

• Added CFrame.setImageRotation()

• Added CFrame.setLayer()

• Added CLayer.getIndex()

• Added CPage.getFrames()

• Added CPage.getMasterPage()

• Added CPage.setMasterPage()

• Added CDialog class for creating custom dialogs:

  • Added CDialog.setTitle()

  • Added CDialog.setSize()

  • Added CDialog.addLabel()

  • Added CDialog.addCheckBox()

  • Added CDialog.addIntField()

  • Added CDialog.addFloatField()

  • Added CDialog.addTextField()

  • Added CDialog.addMultilineTextField()

  • Added CDialog.addMultilineTextInfo()

  • Added CDialog.addDropDown()

  • Added CDialog.addDefaultButtons()

  • Added CDialog.show()

  • Added CDialog.getConfirmingButton()

  • Added CDialog.getCheckBoxValue()

  • Added CDialog.getTextFieldValue()

  • Added CDialog.getMultiLineTextFieldValue()

  • Added CDialog.getFloatFieldValue()

  • Added CDialog.getIntFieldValue()

  • Added CDialog.getDropDownValue()

  • Added CDialog.getSpecification()

• Added dialog module which contains factory functions for CDialog:

  • dialog.create()

• CFrame.moveTo() now also accepts CPage as value for the page parameter

• Fixed CLayer.getVisible() returning wrong values for Illustrator

• Fixed gDocument not being available in panel actions

• Fixed link.collect() parameters pages and placeHolderIDs not being evaluated

R28810

Compatible changes

• InDesign can now use Python in the following situations properly:

  • Placeholder load, build, sync, store (frame and text)

  • Placeholder build post event

  • Publications panel doubleclick

  • Publications events (checkout, after save, after open, etc…)

  • Panel actions for panels: Settings, Publications, Product pool

• Added missing context constants:

  • comet.kContextXMLScript

  • comet.kContextCometTestPreScript

  • comet.kContextCometTestScript

  • comet.kContextCometTestPostScript

  • comet.kContextPlaceHolderStringCompare

  • comet.kContextPlaceHolderBuildPost

• Added gTextModel to Environment variables where appropriate

• Added CFrame.getTextModel()

• Added CDocument.getPages()

• Added CFrame.getPage()

• Added CPage.getDocument()

• Added CPage.getIndex()

• Added CPage.getIndexInSpread()

• Added CPage.getType()

• Added CPage.getSize()

• Added CPage.setSize()

• Added CPage.getMargins()

• Added CPage.setMargins()

• Added CPage.getColumnCount()

• Added CPage.getColumnGutter()

• Added CPage.getName()

• Added new constants for page types - see Page types

• Added new prefs module with new functions:

  • prefs.getAddW2MLToTemplates()

  • prefs.setAddW2MLToTemplates()

  • prefs.getAddW2MLToSnippets()

  • prefs.setAddW2MLToSnippets()

  • prefs.getAddMetaDataToTemplates()

  • prefs.setAddMetaDataToTemplates()

  • prefs.getTagsWriteable()

  • prefs.setTagsWriteable()

  • prefs.setPanelEnabled()

• Fixed gParam1…gParam4 not being available for InDesign layout rules and conditions

• Fixed gDocument not being available for InDesign layout rules and conditions

• Fixed a crash when placeholder funcvar dynamic definition script was empty

• CFrame.getImage() no longer fails if the frame is an empty graphic frame and now returns an empty str

Incompatible changes

• Removed CDocument.getPageCount (was not implemented)

R28726/28730/28732

Compatible changes

• Added wtlog()

• Added CDocument.getBleed()

• Added CDocument.setBleed()

• Added CFrame.getLayer()

• Added CFrame.getObjectStyle()

• Added CFrame.setObjectStyle()

• Added CTable.fitColumn()

• Added CTable.getCellSize()

• Added CTable.getCellStyle()

• Added CTable.setCellStyle()

• Added CTable.insertRows()

• Added CTable.insertColumns()

• Added table.find()

• Added default parameter to comet.wlog() which appends a new line

• Added proper global variables and context to InDesign panel actions

• Added panel actions for Illustrator

• Added ExtendScript calls for Illustrator

• Added allow login action for Illustrator & InDesign

• Added after login action for Illustrator & InDesign

• Added example for CDocument.getStyleNames()

• Added documentation for CDocument.hasAttribute()

• Added global variables to InDesign layout rules (gFrame, gDocument, gStart, gLen, gItem, …)

• Added parameters removeTableOverrides and removeCellStyles to CTable.setStyle()

• CTable functions in Illustrator should now properly justify the provided indices

Incompatible changes

• CFrame.getImagePath is now called CFrame.getImage()

R28703/28704

Compatible changes

• Added Style types constants to comet module

• Added CDocument.getStyleNames()

• Added CFrame.getText()

• Added CFrame.getSize()

• Added CFrame.setSize()

• Added CFrame.isInline()

• Added CRect.getValues()

• Added Import directives documentation

• Added Pubserver imports from [pubserver] paths

• Fixed CDocument.getFrames() crashing when there are no frames in the document

• Fixed CDocument.getFrames() crashing when the layers parameter is empty

• Fixed link.collect() not working with None document

• Fixed link.collect() having wrong defaults for edge parameter

• Some docu look updates

Incompatible changes

• Fixed CFrame.getBBox() returning wrong data type (tuple instead of CRect)