Elemente von Platzhalterlisten (linklist).

Elemente von Platzhalterlisten (linklist).

static int link::set_maxlen(Link lk, int len = -1)

Setze die Maximallänge des Textes, die aus einem Dokumentplatzhalter ermittelt werden kann.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
lk Link - Gültiges Link-Objekt einer linklist
len int -1 Neue Maximallänge für Textinhalte von Platzhaltern
  • >4 : Länge in Bytes
  • Sonst : Beliebige Länge


priint:comet InDesign® Plug-Ins, comet_pdf

linklist

static int link::classid(Link lk)

Hole die Klassennummer des Elementes

Name Typ Default Beschreibung
Return int   id (id2, id3) des Elementes oder 0
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist

static int link::id(Link lk)

Hole die ID des Links.

Name Typ Default Beschreibung
Return int   id des Elementes oder 0
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist
comet.CLink.getRecordID

static int link::id2(Link lk)

Hole die ID2 des Links.

Name Typ Default Beschreibung
Return int   id2 des Elementes oder 0
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist
comet.CLink.getRecordID

static int link::id3(Link lk)

Hole die ID3 des Links.

Name Typ Default Beschreibung
Return int   id3 des Elementes oder 0
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist
comet.CLink.getRecordID

static char* link::sid(Link lk)

Hole die StringID des Elementes.

Name Typ Default Beschreibung
Return char*   StringID des Elementes.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Gültiges Link-Objekt einer linklist

Version 1.3 (Build 96)

priint:comet InDesign® Plug-Ins, comet_pdf

linklist
comet.CLink.getRecordID

static int link::placeholderid(Link lk)

Hole die PlatzhalterID des Elementes.

Name Typ Default Beschreibung
Return int   Platzhalter-ID des Elementes oder 0
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist
comet.CLink.getPlaceHolderID

static int link::sync(Link lk)

Hole den Synchron-Status, der im Element hinterlegt ist. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert. Er kann folgende Werte haben:
Sync-Result Beschreibung Bild
-6 Status undefiniert  
-5 überschrieben Gleichheitszeichen
-4 Fehler beim Laden Oranges zerbrochenes Quadrat
-3 Keine Statusmarkierung  
-2 Objekt nicht gefunden gelb/blaues Quadrat
-1 Geändert Roter Haken
-0 Gelöscht Rotes X
1 Okay Grüner Haken
>1 Objekt nicht eindeutig Oranges +

Name Typ Default Beschreibung
Return int   Synchronstatus des Platzhalters mit dem entsprechenden Objekt
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist
linklist::sync
linklist::collect
comet.CLink.getSyncState

static char* (
  Link lk,
  int fmt = 0,
  int pos = 0,
  int len = -1)

Ermittle den Textinhalt eines Platzhalters. Der Platzhaltertext kann nur nach Aufrufen von linklist::collect ermittelt werden..

Textvariablen werden bei Exportformaten, die reinen Text exportieren (kExportPlain, ...) nicht ersetzt. Der exportierte Text enthält an den Stellen, an denen sich Variablen befinden, den von InDesign® verwendeten internen Zeichencode. Von den ab v3.3 R2883 eingeführten ~Plus~-Formaten werden die Variablen-Platzhalter durch den aktuell im Dokument angezeigten Text ersetzt.

Name Typ Default Beschreibung
Return char*   Textinhalt des Platzhalters. Bei Rahmenplatzhaltern wird der Textinhalt des Rahmens ermittelt. Ist kein Text verfügbar, gibt die Funktion 0 zurück.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Gültiges Link-Objekt einer mit collect geladenen LinkList
fmt int kExportPlain Exportformat, siehe hier
position int 0 Startposition. Der Parameter wird nur bei Rahmenplatzhaltern (isframe () == 1) ausgewertet.
  • >= 0 : Textposition
  • kSelection : Aktuelle Textauswahl.
len int kEnd Anzahl der Zeichen, die geholt werden sollen. Der Parameter wird nur bei Rahmenplatzhaltern (isframe () == 1) ausgewertet.
  • kSelection : Bis zum Textende
  • Sonst : Anzahl der Zeichen
#include "internal/text.h"

Version 1.2.2 (26. Oktober 2005)
~Plus~-Formate seit v3.3 R2883, 20.04.2012

priint:comet InDesign® Plug-Ins, comet_pdf

clear_content
comet.CLink.getContent

static int link::clear_content(Link lk)

Lösche die interne Repräsentation des Textinhaltes eines Platzhalters. Platzhaltertexte können sehr lang sein, in diesem Fall ist es vorteilhaft, die daten aus dem Speicher zu löschen. Der Dokumenttext bleibt von dieser Aktion unverändert. Nach einem erneuten Aufruf von link::content wird der Platzhaltertext neu geladen.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
lk Link - Gültiges Link-Objekt LinkList

Version 1.2.2 (26. Oktober 2005)

priint:comet InDesign® Plug-Ins, comet_pdf

content

static int (Link lk, String result)

DEPRECATED! Hole den Textinhalt, den der Platzhalter im Dokument anzeigt. Der Text ist auf die in set_maxlen bzw, bei linklist::insert angegebene maximale Zeichenzahl begrenzt. Ist der Platzhalter mit einem Rahmen verknüpft, wird der Pfad des Bildes geholt, das im Rahmen angezeigt wird.Der Wert ist nur in den folgenden Fällen definiert :

Name Typ Default Beschreibung
Return char*   Textinhalt des Platzhalters im Dokument. Der Zurückgegebene Zeiger kann in Funktionen verwendet werden, die einen char*-String als Parameter erwarten. Das Ergebnis darf in seiner Länge nicht verändert werden.
lk Link - Gültiges Link-Objekt einer linklist
result String - gültiges String-Objekt.

Version 1.1.5

priint:comet InDesign® Plug-Ins, comet_pdf

Die Funktion wird nicht mehr unterstützt! Verwenden Sie bitte statt dessen die Funktion link::content.
linklist
set_maxlen

static int link::pos(Link lk)

Bei Textplatzhaltern die Startposition im zugehörigen Textmodel, in dem der Platzhalter enthalten ist. Bei Rahmen ist der Wert -1. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return int   An welcher Stelle im zugehörigen Textrahmen beginnt der Platzhalter?
  • -1 : Rahmenplatzhalter
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist::sync
linklist::collect
isframe
comet.CLink.getPosition
comet.CLink.getType

static int link::length(Link lk)

Länge des Platzhaltertextes im Dokument. Bei Rahmen ist der Wert -1. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return int   Textlänge des Platzhalters im Dokument
  • -1 : Rahmenplatzhalter
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist
content_length
linklist::collect
isframe
comet.CLink.getLength
comet.CLink.getType

static int link::content_length(Link lk)

Länge des Textes, der für den Platzhalter ermittelt wurde (in Bytes). Der Wert ist erst nach einem Aufruf von link::content definiert und gibt die Länge des Contents in Abhängigkeit vom gewählten Exportformat an. Diese Länge kann von der mit der Funktion link::length ermittelten Länge differieren. In Versionen vor R 668 hiess diese Funktion textlen, dieser Name hat immer wieder zu folgeschweren Verwechslungen geführt. Deshalb wurde der Aufruf umbenannt.

Name Typ Default Beschreibung
Return int   Textlänge des Platzhalters in Bytes
  • -1 : Rahmenplatzhalter
lk Link - Gültiges Link-Objekt einer linklist

Version 1.15

priint:comet InDesign® Plug-Ins, comet_pdf

linklist
length
comet.CLink.getContent

static int link::pagenum(Link lk)

Seitennummer (bei 1 beginnend) des Platzhalters im Dokument. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return int   Seitennummer des Platzhalters im Dokument
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist::sync
linklist::collect

static int link::pagestr(Link lk, char* result)

Seitenname des Platzhalters im Dokument. Der Name der Seite ist nicht unbedingt identisch mit der Seitennummer als String, reservieren Sie für den Seitennamen also genügend Speicherplatz wenn Sie char* verwenden. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return String oder char* (Abhängig von Parameter result)   Seitenname des Platzhalters im Dokument, entspricht Parameter result
lk Link - Gültiges Link-Objekt einer linklist
result String oder char* - Reservierter Speicher für das Ergebnis


priint:comet InDesign® Plug-Ins, comet_pdf

linklist::sync
page
linklist::collect

static int link::prefix(Link lk, char* result)

Ermittle den aktuellen Präfix des Platzhalters im Dokument. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return String oder char*   value
lk Link - Gültiges Link-Objekt einer linklist
value String oder char* - Reservierter Speicher für das Ergebnis

v4.2 R30710, 11. Mai 2022

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
comet.CLink.getPrefix

static int link::prefix_if_empty(Link lk, char* result)

Ermittle den aktuellen Präfix des Platzhalters wenn sein Inhalt leer ist. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return String oder char*   value
lk Link - Gültiges Link-Objekt einer linklist
value String oder char* - Reservierter Speicher für das Ergebnis

v4.2 R30710, 11. Mai 2022

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
comet.CLink.getPrefixIfEmpty

static int link::postfix(Link lk, char* result)

Ermittle den aktuellen Postfix des Platzhalters im Dokument. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return String oder char*   value
lk Link - Gültiges Link-Objekt einer linklist
value String oder char* - Reservierter Speicher für das Ergebnis

v4.2 R30710, 11. Mai 2022

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
comet.CLink.getPostfix

static int link::postfix_if_empty(Link lk, char* result)

Ermittle den aktuellen Präfix des Platzhalters wenn sein Inhalt leer ist. Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return String oder char*   value
lk Link - Gültiges Link-Objekt einer linklist
value String oder char* - Reservierter Speicher für das Ergebnis

v4.2 R30710, 11. Mai 2022

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
comet.CLink.getPostfixIfEmpty

static int link::isframe(Link lk)

Ist der Platzhalter ein Rahmen? Der Wert ist nur in den Ergebnislisten von linklist::sync und linklist::collect definiert.

Name Typ Default Beschreibung
Return int  
  • 0 Textplatzhalter
  • 1 : Rahmenplatzhalter
1 Rahmenplatzhalter
lk Link - Gültiges Link-Objekt einer linklist


priint:comet InDesign® Plug-Ins, comet_pdf

linklist::sync
linklist::collect
comet.CLink.getFrame
comet.CLink.getType

static char* link::layer(Link lk)

Name der Ebene, auf der der Platzhalter gefunden wurde.

Name Typ Default Beschreibung
Return char*  
  • 0 : lk nicht definiert
  • "" : Inhalt von lk oder Rahmen des Links nicht definiert
  • Sonst : Name der Ebene

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Gültiges Link-Objekt einer linklist

Schnelle Verwendung des Ebenennamens 

li = linklist::first (lli);

while (li)
{
    showmessage ("%s", link::layer (li));
    li = linklist::next (lli);
}

Version 1.2.2 (20. Oktober 2005)

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
comet.CLink.getLayer

static char* link::imagepath(Link lk)

Bild eines Rahmenplatzhalters oder leer, wenn der Rahmen kein Bildrahmen ist.

Name Typ Default Beschreibung
Return char*  
  • Vollständiger Bildpfad
  • 0 : lk nicht definiert
  • "" - Inhalt von lk nicht definiert oder der Rahmen enthält kein Bild oder Rahmen ist kein Bildrahmen

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Gültiges Link-Objekt einer linklist

Schnelle Verwendung des Bildpfades¬ 

li = linklist::first (lli);

while (li)
{
    showmessage ("%s", link::imagepath (li));
    li = linklist::next (lli);
}

Version 1.2.2 (20. Oktober 2005)

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect

static float link::left(Link lk)

Der Wert ist nur in der Ergebnisliste von linklist::collect definiert.Die Funktion collect bestimmt für jeden gefundenen Platzhalter den umschließenden Rahmen. Bei Rahmenplatzhaltern ist das der Rahmen selbst. Bei Textplatzhaltern wird der Rahmen ermittelt, der den eigentlichen Text unmittelbar umschließt. Beide Rahmenangaben werden seitenrelativ in Punkten (1/72 dpi) ermittelt.

Name Typ Default Beschreibung
Return float   X-Position des Rahmens
-10000.0 im Fehlerfall
lk Link - Gültiges Link-Objekt einer linklist

Version 1.2.2 (20. Oktober 2005)

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
link::top
link::right
link::bottom
link::width
link::height

static float link::top(Link lk)


priint:comet InDesign® Plug-Ins, comet_pdf

link::left

static float link::right(Link lk)


priint:comet InDesign® Plug-Ins, comet_pdf

link::top

static float link::bottom(Link lk)


priint:comet InDesign® Plug-Ins, comet_pdf

link::left

static float link::width(Link lk)


priint:comet InDesign® Plug-Ins, comet_pdf

link::left

static float link::height(Link lk)


priint:comet InDesign® Plug-Ins, comet_pdf

link::left

static ItemRef link::frame(Link lk)

Bei Rahmenplatzhaltern gibt die Funktion den Rahmen zurück. Bei Textplatzhaltern wird der Textrahmen zurückgegeben. Befindet sich ein Textplatzhalter ganz oder teilweise im Übersatz, wird der erste Rahmen der Textkette zurückgegeben, sonst der Textrahmen, in dem der Platzhalter gerade gezeigt wird. Der Wert ist nur in der Ergebnisliste von linklist::collect definiert.

Name Typ Default Beschreibung
Return ItemRef   Rahmen oder (bei Textplatzhaltern) Textrahmen des Platzhalters

Die Rückgabevariable darf vorher nicht allokiert sein. Sie darf nicht mit item::release gelöscht werden. Der Inhalt der Variable wird ungültig, wenn das Objekt lk gelöscht wird.
lk Link - Gültiges Link-Objekt einer linklist

Version 1.2.2 (20. Oktober 2005)

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
comet.CLink.getFrame

static int link::set_ui_value(
  Link lk,
  int index,
  char* value)

Setze den Anzeigetext eines Links im Dialog sortlinks_dialog.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
lk Link - Gültiges Link-Objekt
index int - Welche Spalte des Dialoges soll gesetzt werden?
  • 1 - 4 : Setze den Text der gegebenen Spalte
  • Sonst : Fehler
value char* oder String - Anzeigetext. Beachten Sie bitte, dass Zahlen dafür zuvor in Strings umgerechnet werden müssen (siehe z.B. itoa).

v4.2 R30810, 28. Mai 2022

priint:comet InDesign® Plug-Ins

static char* link::get_ui_value(Link lk, int index)

Hole den Anzeigetext eines Links im Dialog sortlinks_dialog. Der Text muß zuvor mit set_ui_value gsetzt worden sein.

Name Typ Default Beschreibung
Return char*   Textinhalt

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Gültiges Link-Objekt
index int - Welcher Spaltentext des Dialoges soll ermittelt werden?
  • 0 : 0-basierter Originalindex des Links in der Liste des Dialoges. Achtung : In diesem - und nur in diesem Fall! - ist der Rückgabewert eine int-Zahl!
  • 1 - 4 : Ermittle den Text der gegbenen Spalte
  • Sonst : Fehler

v4.2 R30810, 28. Mai 2022

priint:comet InDesign® Plug-Ins

static int link::override_sync(Link lk)

überschreibe den Synchron-Status, der im Element hinterlegt ist durch den status "override". Dabei wird der aktuelle Wert des Dokumentes (Textinhalt bei Textplatzhaltern und Bildpfad bei Bildplatzhaltern) zusammen mit dem Wert der Datenquelle im Dokument hinterlegt. Wenn einer der beiden Werte sich ändert wird beim nächsten Sync der Synchronstatus wieder als geändert marktiert.

Diese Funktion darf nur gerufen werden wenn gNewValue nicht definiert ist, sonst kommt es zu einer Endlosschleife.

Diese Funktion hat keine Wirkung wenn die ID der Sync-Aktion größer als -1 ist.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
lk Link - Gültiges Link-Objekt einer linklist

Version 4.1 R10500

priint:comet InDesign® Plug-Ins, comet_pdf

link::remove_override_sync
linklist
linklist::sync

static int link::remove_override_sync(Link lk)

Entfernt den "überschrieben" Synchron-Status, der im Element hinterlegt ist. Die im Dokument gesicherten Werte aus Datenquelle und Dokument werden entfernt.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
lk Link - Gültiges Link-Objekt einer linklist

Version 4.1 R10500

priint:comet InDesign® Plug-Ins, comet_pdf

link::override_sync
linklist
linklist::sync

static int link::count_funcvars(Link lk, int actionType)

Wieviel definierte Funktionsvariablen eines bestimmten Skripttyps hat ein Platzhalter?

Die Funktion liefert nur in LinkList-Listen Ergebnisse, die mit linklist::collect gefüllt wurden.

Name Typ Default Beschreibung
Return int   Anzahl der Funktionsvariablen eines bestimmten Skript-Typs
lk Link - Gültiges Objekt einer LinkList. Die Liste, aus der das Objekt stammt, muß zuvor mit linklist::collect geladen worden sein!
actionType int - Skript der Funktionsvariable
  • 1 : Ladenskript
  • 2 : Sichernskript
  • 3 : Syncskript
  • 4 : Aufbauskript

Version 4.1.5 R21700

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
link::get_nth_funcvar
comet.CLink.getFuncVars

static int link::get_nth_funcvar(
  Link lk,
  int actionType,
  int nth,
  String name = 0,
  String value = 0)

Ermittle Name und aktuellen Wert einer Funktionsvariablen einer Platzhalter-Aktion.

Die Funktion liefert nur in LinkList-Listen Ergebnisse, die mit linklist::collect gefüllt wurden.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
lk Link - Gütiges Objekt einer LinkList. Die Liste, aus der das Objekt stammt, muß zuvor mit linklist::collect geladen worden sein!
actionType int - Skript der Funktionsvariable
  • 1 : Ladenskript
  • 2 : Sichernskript
  • 3 : Syncskript
  • 4 : Aufbauskript
name String oder char* 0 Alllokierter String (string::alloc, char[N], alloc ()) für den erhaltenen Namen der nten Variable
value String oder char* 0 Alllokierter String (string::alloc, char[N], alloc ()) für den erhaltenen aktuellen Wert der nten Variable

Hole alle Platzhalter der ersten Dokumentseite und schreibe deren Funktionsvariablen des Laden-Skriptes ins Log. 

#include "internal/types.h"
#include "internal/text.h"

int main ()
{
    LinkList	lli 	= linklist::alloc ();
    Link		lk;
    int			i;
    char		name	[512];
    String		value	= string::alloc ();

    linklist::collect (lli, 1, "", kFirstIgnore, kSortNo);
    for (lk = linklist::first (lli); lk; lk = linklist::next (lli))
    {
        wlog ("", "Placeholder [%d, %d] with %d load funcvars\n",
         	link::pos (lk),
         	link::pos (lk) + link::length (lk),
         	link::count_funcvars (lk, 1));
        for (i = 0; i < link::count_funcvars (lk, 1); i++)
        {
            link::get_nth_funcvar (lk, 1, i, name, value);
            wlog ("", "   %d : '%s', '%s'\n", i+1, name, value);
        }
    }

    return 0;
}

Version 4.1.5 R21700

priint:comet InDesign® Plug-Ins, comet_pdf

linklist::collect
link::count_funcvars
comet.CLink.getFuncVars

static char* link::crossref::document(Link lk, int what = 1)

Dokument eines Hyperlinks. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return char*   Name oder Pfad des Dokumentes, in dem der Querverweis gefunden wurde.

"" : Fehler

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Objekt, das die Informationen über den Querverweis enthält
what int 1
  • 0 : vollständiger Pfad des Dokumentes
  • 1 : Dokumentname
  • 2 : Dokumentordner

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getDocumentName
comet.CCrossRef.getDocumentPath

static int link::crossref::page(Link lk, int what = 0)

Seitennummer eines Hyperlinks. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return int   Seitennummer eines Querverweises (1-basiert)

0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält
what int 0
  • 0 : Seitennummer im Buch
  • 1 : Seitennummer im Dokument

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getPageIndex

static char* link::crossref::pagename(Link lk, int what = 0)

Seitenname eines Hyperlinks. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return char*   Seitenname eines Querverweises (1-basiert)

"" : Fehler

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Objekt, das die Informationen über den Querverweis enthält
what int 0  
what int 0
  • 0 : Seitenname im Buch
  • 1 : Seitenname in Abhängigkeit der Seitenparameter in hyperlink::find

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getPageName

static char* link::crossref::name(Link lk)

Name eines Hyperlinks. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter. Da InDesign® die Namen von Hyperlinks durch Anhängen einer Zählnummer eindeutig macht, kann der erhaltene Name sich vom Namen, unter dem Sie das Verweisziel gesucht haben, durch diese Zählnummer unterscheiden.

Name Typ Default Beschreibung
Return char*   Name eines Querverweises

"" : Fehler

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getName

static char* link::crossref::destination(Link lk)

Name des Verweiszieles eines Hyperlinks. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.Da InDesign® die Namen von Hyperlink-Zielen durch Anhängen einer Zählnummer eindeutig macht, kann der erhaltene Ziel-Name sich vom Ziel-Namen (classid id id2 id3 stringid), unter dem Sie das Verweisziel gesucht haben, durch diese Zählnummer unterscheiden.

Name Typ Default Beschreibung
Return char*   Name des Verweiszieles eines Querverweises

"" : Fehler

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getDestination

static float link::crossref::x(Link lk)

x-Position des Verweiszieles in Punkten relativ zum Textrahmen. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find mit calcTextPos = 1 einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return float   x-Position des Verweiszieles in Punkten relativ zum Textrahmen.

-10000.0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getPosition

static float link::crossref::y(Link lk)

y-Position der Zeile des Verweiszieles in Punkten relativ zum Textrahmen. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find mit calcTextPos = 1 einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return float   y-Position der Zeile des Verweiszieles in Punkten relativ zum Textrahmen.

-10000.0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getPosition

static float link::crossref::left(Link lk)

x-Position des Rahmens des Verweiszieles in Punkten. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return float   x-Position des Rahmens des Verweiszieles in Punkten.

-10000.0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getFrameBBox

static float link::crossref::top(Link lk)

y-Position des Rahmens des Verweiszieles in Punkten. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return float   y-Position des Rahmens Verweiszieles in Punkten.

-10000.0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getFrameBBox

static float link::crossref::right(Link lk)

x-Position der rechten unteren Ecke des Rahmens des Verweiszieles in Punkten. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return float   x-Position der rechten unteren Ecke des Rahmens des Verweiszieles in Punkten.

-10000.0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getFrameBBox

static float link::crossref::bottom(Link lk)

y-Position der rechten unteren Ecke des Rahmens des Verweiszieles in Punkten. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return float   y-Position der rechten unteren Ecke des Rahmens Verweiszieles in Punkten.

-10000.0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getFrameBBox

static int link::crossref::pos(Link lk)

Textposition des Verweiszieles. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return int   Textposition Verweiszieles (0-basiert)

-1 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getIndex

static int link::crossref::frame(Link lk)

Dokumentrahmen des Verweiszieles. Der Aufruf liefert nur nach einem Aufruf von hyperlink::find einen gültigen Wert. Siehe auch Querverweis-Platzhalter.

Name Typ Default Beschreibung
Return ItemRef   Rahmenreferenz des Textrahmens des Verweiszieles

0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

Version 2.1 R668, 9. April 2008

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getFrame

static ItemRef link::crossref::src_frame(Link lk)

Dokumentrahmen des Verweises.

Name Typ Default Beschreibung
Return ItemRef   Dokumentrahmen des Verweises.

0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

v3.3 R3116, 13.08.2012

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getSourceFrame

static int link::crossref::src_textpos(Link lk)

Textposition, an der der Verweis beginnt.

Name Typ Default Beschreibung
Return int   Textposition, an der der Verweis beginnt.

-1 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

v3.3 R3116, 13.08.2012

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getSourceIndex

static int link::crossref::src_textlen(Link lk)

Textlänge des Verweises.

Name Typ Default Beschreibung
Return int   Textlänge des Verweises.

-1 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

v3.3 R3116, 13.08.2012

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
comet.CCrossRef.getSourceLength

static ItemRef link::crossref::hyperlink_ref(Link lk)

Dokumentreferenz des Verweises.

Name Typ Default Beschreibung
Return ItemRef   Dokumentreferenz des Verweises.

0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

v3.3 R3116, 13.08.2012

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist

static ItemRef link::crossref::anchor_ref(Link lk)

Dokumentreferenz des Verweis-Zieles.

Name Typ Default Beschreibung
Return ItemRef   Dokumentreferenz des Verweises-Zieles.

0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

v3.3 R3116, 13.08.2012

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
type
info

static int link::crossref::type(Link lk)

Typ des Verweiszieles.

Name Typ Default Beschreibung
Return int  
  • 0 : Textanker
  • 1 : Seite
  • 2 : URL
  • 3 : Extern
lk Link - Objekt, das die Informationen über den Querverweis enthält

v3.3 R3116, 13.08.2012

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
info

static char* link::crossref::info(Link lk)

Informationen über das Verweis-Ziel (z.B. die URL oder Angaben zur eMail).

Name Typ Default Beschreibung
Return char*   Informationen über das Verweis-Ziel (z.B. die URL oder Angaben zur eMail).
0 : Fehler
lk Link - Objekt, das die Informationen über den Querverweis enthält

v3.3 R3116, 13.08.2012

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
info

static int link::crossref::key(Link lk)

Key der Hyperlink-Zieldefintion. Die Funktion liefert nur nach Aufrufen von hyperlink::find mit den crossRefName-Präfixen "defns" und "defns_info" einen definierten Wert.

Name Typ Default Beschreibung
Return int   Key des der Defintion des Verweiszieles

-1 : Fehler
lk Link - HyperlinkDestinationDef-Objekt aus einem Aufruf von hyperlink::find mit den crossRefName-Präfixen "defns" oder "defns_info"

Schreibe alle HyperlinkDestinationDefs des aktuellen Dokumentes in Logfile. 

int main ()
{
    LinkList	lks		= linklist::alloc ();
    Link		lk;

    wlog ("", "HyperlinkDestDefns by name:\n");
    hyperlink::find (lks, 0, "defn:'*'");
    for (lk = linklist::first (lks); lk; lk = linklist::next (lks))
    {
        wlog ("", "'%s' [%d], type %d--> '%s'\n",
          		link::crossref::name (lk),
          		link::crossref::key (lk),
          		link::crossref::type (lk),
          		link::crossref::destination (lk));
    }

    wlog ("", "\nHyperlinkDestDefns by info:\n");
    linklist::clear (lks);
    hyperlink::find (lks, 0, "defn_info:'*'");
    for (lk = linklist::first (lks); lk; lk = linklist::next (lks))
    {
        wlog ("", "'%s' [%d], type %d--> '%s'\n",
          		link::crossref::name (lk),
          		link::crossref::key (lk),
          		link::crossref::type (lk),
         		link::crossref::destination (lk));
    }

    return 0;
}

v5.0 R37000

priint:comet InDesign® Plug-Ins, comet_pdf

hyperlink::find
linklist
hyperlink::get_next_unique_key

Seit
1.0.19

Alphabetic index HTML hierarchy of classes or Java