Manuel XFRX

Cette page est une traduction du site EQEUS datant de 2015.
Pour la documentation complète et à jour consultez les pages sur site de l'éditeur EQEUS.

Dé-zipper le fichier archive zip.
Pour un aperçu rapide des possibilités lancez DEMO.SCX.
Consultez la rubrique FAQ et son exemple.

XFRX est composé de 4 fichiers :

• XFRX.APP - C'est l'application XFRX
• HNDLIB.DLL
• XFRXLIB.FLL
• ZLIB.DLL - (Utilitaire de compression "freeware", voir www.zlib.org pour plus d'information)

1. Création d'une zone source
   Saisissez le texte suivant dans la zone 'comment' d'un objet du générateur de rapport :

   #UR A HREF=

   Le nom de destination est une expression, qui est évaluée au moment de la production de l'état. Vous pouvez diriger vers d'autres zones dans le même document, ou vers n'importe quelle URL.
   Les destinations vers des zones du même document doivent être précédées d'un #.

   Exemples :
   #UR A HREF="#top"
   Ajoute un lien cliquable vers le début du document.
   "top" est un mot reservé (ne pas nommer une zone "top" de destination).

   #UR A HREF="#custlist"
   Ajoute un lien cliquable vers une zone du même document nommée "custlist".

   #UR A HREF="#"+customer.id
   Ajoute un lien cliquable vers une zone du même document nommée eval(customer.id).

   #UR A HREF="http://www.xfrx.net"
   Ajoute un lien cliquable vers la page d'accueil du site xfrx.net.

2. Création d'une zone de destination
   Pour ajouter un nom de zone de destination, saisissez le texte suivant dans la zone 'comment' d'un objet du générateur de rapport :

   #UR A NAME=

   Exemple :
   #UR A NAME="#"+customer.id
   Cette zone sera la destination des liens ayant comme zone source HREF="#"+customer.id

Les signets servent de 'table des matières' en permettant de résumer la structure du document. Les utilisateurs peuvent utiliser les signets pour cliquer et se diriger directement vers la partie du document qui les intéresse. Pour ajouter un signet dans une document, il suffit de saisir le texte suivant dans la zone 'comment' d'un objet du générateur de rapport :

#UR OUTLINE=

Le est une expression, qui est évaluée au moment de la génération du rapport et le résultat est utilisé pour créer l'entrée dans la table des signets. Si l'utilisateur clique sur cette entrée de signet, alors il navigue et arrive sur la zone correspondante à ce champ de destination.

Exemple :
Dans un rapport ayant une liste de factures groupées par des clients, un signet contenant la liste des clients peut être créé en ajoutant :

#UR OUTLINE=invoices.customerName

dans la zone 'comment' de l'objet 'client' du générateur de rapport (ou dans n'importe quel autre objet que vous souhaitez, par exemple le premier champ de la page du client).

Pour activer les signets en sortie HTML, appelez

loSession.SetOtherParams("PRINT_BOOKMARKS",.t.)

avant d'appeler loSession.ProcessReport()

Avec les signets activés, XFRX doit générer 3 pages HTML (3 fichiers): la page principale définissant le cadre de page, la page des signets et la page avec le rapport.

Propriétés Générales

loSession.setAuthor() : Auteur
loSession.setTitle()
loSession.setSubject() : Sujet
loSession.setKeywords() : Mots clefs

Propriétés pour les document PDF seulement

loSession.setCreator() : Créateur
loSession.setProducer() : Producteur

Propriétés pour les document DOC seulement

loSession.setComments() : Commentaires
loSession.setCategory() : Catégorie
loSession.setManager() : Responsable
loSession.setCompany() : Société

L'objet de barre de progression est attaché à XFRX par l'appel de la méthode "setProgressObj()".
Cette méthode demande deux paramètres : le premier est l'objet de barre de progression et le second définit les informations à retourner à la méthode updateProgress().
  Il peut avoir deux valeurs :
    1 - seuls le numéro de page et le numéro de rapport sont transmis à la méthode updateProgress(),
    2 - le numéro de page, le numéro de rapport et le pourcentage de progression dans le rapport en cours sont transmis.
   L'utilisation du pourcentage est plus précis et plus approprié pour visualiser une barre de progression, mais pour faire cela, XFRX doit calculer le nombre d'enregistrements traités, et cela, peut parfois, demander beaucoup de temps.
La méthode "updateProgress" prend ces trois paramètres respectivement :
  le numéro de rapport actuel, le numéro de page actuel, le pourcentage actuel du rapport en traitement.

Le propriétaire peut faire ce qu'il veut du document.
Les permissions données à l'utilisateur peuvent être définies en utilisant la méthode "setPermission" :

loSession.setPermissions(tlPrintDocument, tlModifyDocument, ;
tlCopyTextAndGraphics, tlAddOrModifyAnnotations)


Les valeurs des permissions par défaut sont fixées à .F. (faux).

Exemple :
Le code suivant produira et cryptera un document de pdf. L'utilisateur ne pourra ni imprimer, ni modifier, ni copier le texte du document, mais il pourra ajouter ou modifier des annotations :

local loSession, lnRetval
loSession=EVALUATE([report("XFRX#INIT")])
lnRetVal = loSession.SetParams("out.pdf",,,,,,"PDF")
If lnRetVal = 0
  loSession.setPasswords("ownerpassword","userpassword")
  loSession.setPermissions(.f.,.f.,.f.,.t.)
  loSession.ProcessReport("myreport")
  loSession.finalize()
Endif


Remarque : pour le calcul MD5 , XFRX utilise "RSA Data Security, Inc. MD5 Message-Digest Algorithm."

avant de lancer le rapport.

Pour ajouter seulement les caractères utilisés :

loSession.setEmbeddingType(3)

L'ajout des caractères utilisés uniquement, réduit la taille du fichier généré.

Pour sélectionner uniquement une police de caractères particulière à ajouter, (par exemple quand vous voulez seulement ajouter une police code à barre, où visualiser un document sur une machine qui ne dispose pas de cette police de caractères),  ajouter :

"#UR INCLUDEFONT" (sans les guillements) dans la zone "comment", d'un objet du générateur de rapport, utilisant cette police de caractères.

ajouter :
"#UR INCLUDEFONT SUBSET" pour ajouter seulement les caractères utilisés.

1. Ajouter une instance de la classe XFCONT (de la bibliothèque XFRXLIB.VCX) dans votre formulaire.
2. Appelez la méthode "Reset" de l'objet XFCONT :
   thisform.xfcont1.reset()

3. Initialiser l'objet session :
   local loSession, lnRetval
loSession=EVALUATE([xfrx("XFRX#INIT")])
lnRetVal = loSession.SetParams(,,,,,,"CNT")

4. Attacher l'objet XFCONT dans l'objet session :
   loSession.SetOtherParams(thisform.xfcont1)

5. Lancer la méthode ProcessReport() et Finalize() comme d'habitude : loSession.ProcessReport("demoreps\invinl", "customer = '"+ALLTRIM(this.displayvalue)+"'")
loSession.Finalize()


Regardez le formulaire de démonstration, pour voir un exemple de prévisualisation de rapport dans un objet "container".

Le paramètre tlRequirePassword est optionnel (valeur par défaut à .F.)
S'il est fixé à .T., Word⁽¹⁾ demandera le mot de passe lors de l'ouverture du document.

• setPageRange(tnFrom, tnTo)
  tnFrom  et  tnTo définissent de la plage de page "From" à la page "To" .
  Si tnTo n'est pas précisé, le nombre total de page est utilisé
  
  Exemple:  Impression de la page numéro 5 à la page numéro 10loSession.setPageRange(5,10)
• setPageRange(tcRange)
  tcRange est une chaine, qui peut contenir des numéros de page et des plage de page séparés par des virgules,
  la plage de page est définie comme "de-à".
  
  Exemple: Impression de la page 1, de la page 4, des pages 10 à 20 et la page 25loSession.setPageRange("1,4,10-20,25")

L'unité est le pouce * 10000.

ou placer votre propre valeur de marge de page.
L'unité est le pouce * 10000, ainsi pour rendre la page plus courte de 2 pouces, appellez :

ShrinkHeight(20000)

La valeur fixée par la méthode de ShrinkHeight() est appliquée à tous les types de conversions, pas uniquement à HTML.

Documentation «EQEUS»