iAddBookmark (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Print functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Print functions

iAddBookmark (Function)

In french: iAjouteSignet

Ajoute un signet dans le visualisateur de rapports ou lors de l'export en PDF.

Dans le visualisateur de rapports, un arbre permet d'atteindre la position des signets générés.

New in version SaaS

Cette fonction est désormais disponible pour les sites WEBDEV sous Linux.

Cette fonction est désormais disponible pour les applications WINDEV sous Linux.

Example

// Print in "Report viewer" mode
iDestination(iViewer)

// Add the root bookmark
iAddBookmark("Root", "MyDocument")
// Add a bookmark at the top of first page
iAddBookmark("Page 1", "Page 1", "Root")
// Positions a bookmark and a text at 5 cm from the top of the page
iYPos(50)
iAddBookmark("Page 1 line 1", "First line of the first page", "Page 1")
iPrint("First line of the first page")

// Print the page 2
iSkipPage()
// Add a bookmark at the top of the page
iAddBookmark("Page 2", "Page 2", "Root")
// Print two lines
iPrint("First line of the second page")
iPrint("Second line of the second page")
// Adds a bookmark for the third line
iAddBookmark("Page 2 line 3", "Third line of the second page", "Page 2")
iPrint("Third line of the second page")

// End of print
iEndPrinting()

Syntax

<Résultat> = iAjouteSignet(<Identifiant du signet> , <Libellé> [, <Identifiant du parent>])

<Résultat>: Booléen

Vrai si le signet a été ajouté,
Faux en cas de problème.

<Identifiant du signet>: Chaîne de caractères

Identifiant unique du signet. Si cet identifiant existe déjà, une erreur WLangage est générée.

<Libellé>: Chaîne de caractères

Libellé du signet. Ce libellé permettra à l'utilisateur d'accéder directement à la partie de texte correspondant au signet.

<Identifiant du parent>: Chaîne de caractères optionnelle

Identifiant unique du signet parent du signet à créer.
Si ce paramètre n'est pas précisé, le signet est créé à la racine.
Si l'identifiant du parent n'existe pas, <Résultat> renvoie Faux et le signet est créé à la racine.

Remarks

Lors des impressions programmées, le signet est créé à la position courante.
Lors de l'impression d'un état, la fonction iAddBookmark doit être utilisée dans le code d'impression d'un champ ou d'un bloc. Le signet est alors créé à la position du champ ou du bloc correspondant.

Business / UI classification: Neutral code

Component: wd300prn.dll