comet.CCometGroup¶

class comet.CCometGroup¶

Methods¶

CCometGroup.getDocument() → CDocument¶

Get the document of this group.

Returns:: The document this group belongs to
Return type:: CDocument
Available:: InDesign® comet_pdf® Illustrator®

CCometGroup.getID() → int¶

Get the ID of this group.

Returns:: The ID of this group
Return type:: int
Available:: InDesign® comet_pdf® Illustrator®

CCometGroup.getMembers() → list[CFrame]¶

Get all members of this group.

Returns:: The members of this group
Return type:: list[CFrame]
Raises:: TypeError – When parameter types are invalid
Available:: InDesign® comet_pdf® Illustrator®
CScript:: itemlist::get_cometgroup_members

CCometGroup.addMembers(members: list[CFrame]) → None¶

Add new members to this group.

Parameters:: members (list[CFrame]) – New members to add
Raises:: TypeError – When parameter types are invalid
Available:: InDesign® comet_pdf® Illustrator®
CScript:: itemlist::add_to_cometgroup

CCometGroup.removeMembers(members: list[CFrame]) → None¶

Remove members from this group.

Parameters:: members (list[CFrame]) – Members to remove
Raises:: TypeError – When parameter types are invalid
Available:: InDesign® comet_pdf® Illustrator®
CScript:: itemlist::remove_from_cometgroup

CCometGroup.remove() → None¶

Remove this comet group from it’s document by removing all members.

All subsequent calls to this object will fail.

Available:: InDesign® comet_pdf® Illustrator®
CScript:: itemlist::resolve_cometgroup

Special methods¶

CCometGroup.__repr__() → str¶

String representation.

Returns:

<CCometGroup> ID: ID | Member count: Member count

Example¶

<CCometGroup> ID: 340 | Member count: 3

Return type: