DocInsertToc¶
Fügt einem Dokument ein Inhaltsverzeichnis zu oder aktualisiert es.
-
bool = DocInsertToc(hDoc)
Returnwert
bool
Parameter
-
hDoc
hDoc ist die Zugriffsnummer des mit DocCreate erzeugten Dokuments.
Kommentar
Beim Zufügen eines Inhaltsverzeichnisses verwendet die Funktion eine Vorlage. Die Vorlage ist eine IPW-Datei mit einer Seite, die ein Tabellenobjekt enthalten muss. Das Tabellenobjekt muss 3 Spalten und mindestens 10 Zeilen enthalten. Die erste Zeile des Tabellenobjekts kann eine Spaltenbeschreibung enthalten. Das Tabellenobjekt muss den Namen „contents-do-not-change“ tragen.
In die erste Spalte der Tabelle trägt die Funktion die Seitennamen ein. In die zweite Spalte wird eine Beschreibung aus der Seite eingetragen. Dazu sucht die Funktion den Text eines Textobjektes mit dem Namen „$comment$“. In die dritte Spalte wird die Seitennummer eingetragen.
Falls keine Beschreibung aus der Seite angezeigt werden soll, kann die Breite der zweiten Spalte auf 0 gesetzt werden.
Der Seitenname des Inhaltsverzeichnisses kann mit dem folgenden Aufruf
festgelegt werden. Ersetzen Sie dazu den Text Contents
durch einen
anderen Text.
WriteProfileString("settings", "page-contents-name", "Contents");
Der Standardplatzhalter kann mit dem folgenden Aufruf durch einen anderen Platzhalter ersetzt werden.
WriteProfileString("settings", "page-contents-placeholder", "$Title$");
Die Vorlage wird mit dem folgenden Aufruf festgelegt. Eine Beispielvorlage
finden Sie im Template-Verzeichnis von UniPlot
(contents-template-de.ipw
).
WriteProfileString("settings", "page-contents-template", "d:/toc-template.ipw");
History
Version | Beschreibung |
---|---|
5.9.3 | Neu. |
Siehe auch
id-1588476