1. Appeler XFRX avec le paramètre "XFRX#INIT"
   
   loSession=XFRX("XFRX#INIT")
   
   Une référence d'objet de la classe XFRXSession sera retournée.
   
   
2. Appeler la méthode SetParams pour fixer les paramètres de génération du document.  

   lnRetVal = loSession.SetParams(<tcOutputName>, <tcTempDirectory>, <tlNotOpenViewer>, <tcCodePage>, <tlSilent>, <tlNewSession>, <tcTarget>)

   Paramètres :

   <tcOutputName>	Le nom du document à créer.
   <tcTempDirectory>	Répertoire où les fichiers temporaires pourront être créés. Si rien n'est précisé alors les fichiers temporaires pourront être créés dans le répertoire courant [facultatif]
   <tlNotOpenViewer>	si fixé à .T. : les documents ne seront pas ouvert après génération [facultatif]
   <tcCodePage>	C'est le 'codepage' du document généré. [facultatif]. Si vous ne spécifiez pas ce paramètre alors cpcurrent() est utilisé.
   <tlSilent>	si fixé à .T.  : aucun message sera affiché. [facultatif] Cette option est utile si votre application n'est pas en anglais et/ou vous ne voulez pas voir le message "Processing..." et les message d'erreur dans votre code. (Cette option est indispensable si vous générez un COM+ en DLL)
   <tlNewSession>	Par défaut, les documents Word(1) seront générés dans la session Word(1) actuelle, si elle existe. Si ce paramètre est fixé à .T., le document sera toujours ouvert dans une nouvelle session de Word(1). Cette option n'est pas utilisée pour les documents PDF. [facultatif]
   <tcTarget>	Utilisez : "DOC" pour les documents Word(1), "PDF" pour les documents PDF, "HTML" pour les documents HTML, "MHT" pour les documents MHT, "CNT" pour les objets 'container' (regardez Prévisualisation des rapports dans un objet "container" pour plus d'information). "DOC" est la valeur par défaut. [facultatif]

   
   Valeurs retournées :
   0 ... Tout est OK
   -1 ... n'a pas pu charger Word⁽¹⁾
   -2 ... la version de Word⁽¹⁾ n'est pas en version 2000 ou ultérieure
   -3 ... impossible d'accéder au fichier destination à créer
   -4 ... destination inconnue
   -5 ... librairie hndlib.dll non trouvée
   -6 ... librairie xfrxlib.fll non trouvée
   -7 ... librairie zlib.dll non trouvée

3. Appeler la méthode ProcessReport pour transformer le rapport en document Word⁽¹⁾ (vous devrez probablement d'abord préparer des données pour le rapport):

   loSession.ProcessReport(<tcReportName>, <tcForClause>, <tlSummary>,
   <tcScopeClause>, <tcWhileClause>, <tlPlain>)

   Paramètres :

   <tcReportName>	nom du rapport
   <tcForClause>	Contenu de la clause FOR [facultatif]
   <tlSummary>	Le commutateur de la clause SUMMARY. Si fixé à .T. le rapport est généré comme si la clause SUMMARY était utilisée dans la commande "REPORT FORM" [facultatif]
   <tcScopeClause>	La chaine correspondante aux clauses de portée du rapport (comme NEXT 4, REST, ALL, RECORD nRecno). Par défaut la valeur est "ALL" [facultatif]
   <tcWhileClause>	La clause "WHILE" [facultatif]
   <tlPlain>	Fixer ce paramètre à .T. pour placer la sortie HTML au format entier. Le format entier ne produit pas de coupure de page au document : une longue page sera produite. La valeur par défaut est .F.

   
   Exemple :
   

   loSession.ProcessReport("myreport", "customer=30", .f., "NEXT 10", "!empty(invoiceNo")

   Vous pouvez répéter l'appel de la méthode ProcessReport pour différents rapports autant de fois que vous en avez besoin. 

4. Appeler la méthode Finalize() pour terminer la génération du document :

   loSession.finalize()

   Après cet appel, le fichier souhaité est créé, et, sur option, la visualisation de ce document est lancée.

5. Vous pouvez aussi appeler la méthode ResetPageNo() si vous voulez remettre à zéro le numéro de page des rapports intermédiaires.

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=<destination name>

   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=<destination 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=<outline_name>

Le <outline_name> 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(<author>) : Auteur
   loSession.setTitle(<title>) : Titre
   loSession.setSubject(<subject>) : Sujet
   loSession.setKeywords(<keywords>) : Mots clefs

Propriétés pour les document PDF seulement

   loSession.setCreator(<creator>) : Créateur
   loSession.setProducer(<producer>) : Producteur

Propriétés pour les document DOC seulement

   loSession.setComments(<comments>) : Commentaires
   loSession.setCategory(<category>) : Catégorie
   loSession.setManager(<manager>) : Responsable
   loSession.setCompany(<company>) : Société

loSession=xfrx("XFRX#Init")
loProgress = createobject("progress")
lnRetVal = loSession.SetParams("document",,,,,,"PDF")
if lnRetVal = 0
   loSession.setProgressObj(loProgress,2)
   loSession.ProcessReport("myReport")
   loSession.finalize()
endif

define class progress as custom
   procedure updateProgress
      lpara ta,tb, tc
      wait window nowait "Page #: "+allt(str(tb))+" Report #: "+allt(str(ta))+" ("+allt(str(tc))+"%)"
enddef

Le "mot de passe utilisateur" peut être vide. Si le "mot de passe propriétaire" est vide, alors une chaine aléatoire est générée pour le mot de passe.

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".

Vous pouvez omettre l'un ou l'autre des tcReadPassword or tcWritePassword.

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.

tnPagesp  étant le nombre de pages de chacun des documents résultants.

• 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.