Find all cross reference destinations of a given name and a given Comet ID.
Cross reference destinations are created using
with the <w2cross> tag or using the product pool panel submenu Insert Cross Reference.
A detailed description about Comet cross references can be found here
While creating cross reference destinations, InDesign® takes care of unique names by appending a counter to the names.
This is the reason why you may have more than one cross reference destination with the same name and ID in the document.
The find function ignores this counter and will find all cross reference destinations beginning with the
given name and/or Comet ID string containing of classid, ID, ID2, ID3 and StringID of the given Comet-ID.
You may wish to search all documents of the book containing the given document.
In this case all documents of the book will be opened and closed in the background automatically.
The Comet document watch mechanism is turned off in this situation.
Cross reference destinations in overset will not be found!
scope (CDocument) – The document to search in
name (str) –
Name of the destination to search for.
Find all destinations beginning with the given name.
May be empty.
classID (int) – Class ID of the following comet object
recordID (tuple[int, int, int, str] | CIDType) –
Comet object ID.
The parameter type can be:
findInBook (bool) – Search in all documents of the book the document belongs to?
calcTextCoords (bool) –
Calculation of text coordinates is expensive and must therefore be enabled manually.
A list of found crossrefs
- Return type
TypeError – When parameter types are invalid