comet.CCrossRef¶
- class comet.CCrossRef¶
See also
Module hyperlink
Methods¶
- CCrossRef.getName()¶
Get the name of the cross reference destination.
- Returns
The reference name
- Return type
- Raises
CometError – On internal error
- Available
- CScript
- CCrossRef.getDocumentName()¶
Get the document name of the cross reference destination.
- Returns
The document name
- Return type
- Raises
CometError – On internal error
- Available
- CScript
- CCrossRef.getDocumentPath()¶
Get the full path to the document of the cross reference destination.
- Returns
The document path
- Return type
- Raises
CometError – On internal error
- Available
- CScript
- CCrossRef.getPageIndex(fromBook=True)¶
Get the page indef of the cross reference destination.
- Parameters
fromBook (bool) –
Get the index from the book or document
- Returns
The page index
- Return type
- Raises
TypeError – When parameter types are invalid
CometError – On internal error
- Available
- CScript
- CCrossRef.getPageName(fromBook=True)¶
Get the page name of the cross reference destination.
- Parameters
fromBook (bool) –
Get the name from the book or document.
- Returns
The page name
- Return type
- Raises
TypeError – When parameter types are invalid
CometError – On internal error
- Available
- CScript
- CCrossRef.getDestination()¶
Get the Comet ID of the cross reference destination.
The result may have a number appended when multiple crossrefs with the same ID exist.
- Returns
The comet ID as a string
- Return type
- Raises
CometError – On internal error
- Available
- CScript
- CCrossRef.getPosition()¶
Get the coordinates of the cross reference destination’s text position.
The coordinates are relative to the containing frame.
This function only yields valid values when the coordinates were calculated during
hyperlink.findCrossRefs()- Returns
The coordinates of the text position
- Return type
- Raises
CometError – On internal error
- Available
- CScript
- CCrossRef.getFrameBBox()¶
Get the frame bounding box of the cross reference destination’s text frame.
- Returns
The frame bounding box of the cross reference destination’s text frame
- Return type
- Raises
CometError – On internal error
- Available
- CScript
- CCrossRef.getIndex()¶
Get the text anchor index of the cross reference destination.
- Returns
The text anchor index
- Return type
- Raises
CometError – On internal error
- Available
- CScript
- CCrossRef.getFrame()¶
Get the frame of the cross reference destination.
- Returns
The frame containing the destination
- Return type
- Raises
CometError – On internal error
- Available
- CScript