Aller au contenu principal
Version : 21 R3 BETA

WP EXPORT VARIABLE

WP EXPORT VARIABLE ( wpDoc : Object ; destination : Text, Blob ; format : Integer {; option : Object, Integer} )

ParamètresTypeDescription
wpDocObjectVariable 4D Write Pro
destinationText, BlobVariable pour recevoir les contenus exportés
formatIntegerFormat de sortie variable
optionObject, IntegerOptions d'export

Description

La commande WP EXPORT VARIABLE exporte l'objet wpDoc 4D Write Pro vers la variable 4D destination dans le format spécifié.

Dans wpDoc, passez l'objet 4D Write Pro que vous souhaitez exporter.

Dans destination, passez la variable que vous voulez remplir avec l'objet exporté de 4D Write Pro. Le type de cette variable dépend du format d'exportation spécifié dans le paramètre format :

  • Si vous passez le format .4wp natif ou le format .docx, la variable sera de type Blob,
  • Si vous passez un format HTML ou SVG, la variable sera du type Text.

Dans le paramètre format, passez une constante du thème 4D Write Pro Constants pour définir le format d'exportation que vous souhaitez utiliser. Chaque format est lié à une utilisation spécifique. Les formats suivants sont pris en charge:

ConstanteTypeValeurCommentaire
wk 4wpInteger4Le document 4D Write Pro est sauvegardé dans un format d'archive natif (HTML zippé et images sauvegardées dans un dossier séparé). Les balises spécifiques 4D sont incluses et les expressions 4D ne sont pas calculées. Ce format est particulièrement adapté à la sauvegarde et à l'archivage des documents 4D Write Pro sur disque sans aucune perte.
wk docxInteger7Extension .docx. Le document 4D Write Pro est enregistré au format Microsoft Word. Prise en charge certifiée de Microsoft Word 2010 et versions ultérieures.
Les parties du document exportées sont les suivantes
  • Corps / en-têtes / pieds de page / sections
  • Page / paramètres d'impression (marges, image / couleur d'arrière-plan, bordures, padding, taille du papier / orientation)
  • Images - en ligne, ancrées, et motif d'image d'arrière-plan (défini avec wk background image)
  • Feuilles de style (caractère, paragraphe)
  • Variables et expressions compatibles (numéro de page, nombre de pages, date, heure, métadonnées). Les variables et expressions non compatibles seront évaluées et figées avant l'exportation.
  • Liens - Signets et URLs
Notez que certains paramètres de 4D Write Pro peuvent ne pas être disponibles ou se comporter différemment dans Microsoft Word.
wk mime htmlInteger1Le document 4D Write Pro est sauvegardé en tant que MIME HTML standard avec les documents HTML et les images intégrées en tant que parties MIME (encodées en base64). Les expressions sont calculées et les balises spécifiques à 4D ainsi que les liens de méthode sont supprimés. Seules les zones de texte ancrées dans la vue intégrée sont exportées (sous forme de divs). Ce format est particulièrement adapté à l'envoi de mails HTML.
wk pdfInteger5Extension .pdf. Le document 4D Write Pro est enregistré au format PDF, sur la base du mode d'affichage Page. Les métadonnées suivantes sont exportées dans un document PDF : Titre Auteur Sujet Créateur du contenu Notes : Les expressions sont automatiquement figées lors de l'exportation du document. Les liens vers les méthodes ne sont PAS exportés
wk svgInteger8La page du document 4D Write Pro est sauvegardée au format SVG, sur la base du mode d'affichage Page. Note: Lors de l'exportation en SVG, vous ne pouvez exporter qu'une page à la fois. Utilisez wk page index pour spécifier la page à exporter.
wk web page html 4DInteger3Le document 4D Write Pro est enregistré en HTML et comprend des balises spécifiques à 4D ; chaque expression est insérée sous forme d'espace insécable. Comme ce format est sans perte, il est approprié à des fins de stockage dans un champ texte.

Notes :

  • "Balises spécifiques 4D" signifie XHTML 4D avec un espace de noms 4D et des styles CSS 4D.
  • Pour plus d'informations sur le format du document 4D Write Pro, reportez-vous à .4wp document format.
  • Pour consulter la liste des différences ou des incompatibilités connues lors de l'utilisation du format .docx, voir Importation et exportation au format .docx.
  • Lors de l'exportation au format SVG avec cette commande, les images sont intégrées au format base64.
  • Pour plus d'informations sur l'exportation au format SVG, voir Exportation au format SVG.

Paramètre option

Passez dans option un objet contenant les valeurs pour définir les propriétés du document exporté. Les propriétés suivantes sont disponibles :

ConstanteValeurCommentaire
wk CID host domain namecidHostDomainNom du domaine de l'hôte CID : domaine de l'hôte qui sera ajouté aux URL CID générées, y compris un "@" comme séparateur. Disponible uniquement lorsque le format wk mime html est utilisé.
wk embedded picturesembeddedPicturesPour l'exportation SVG uniquement. Définit si les images sont intégrées dans le fichier .svg exporté lorsque vous appelez WP EXPORT DOCUMENT. Valeurs disponibles :
  • true (par défaut) : Les images sont intégrées dans le fichier .svg exporté
  • false : Les images sont exportées dans un dossier appelé "nom_de_fichier_images" au niveau du fichier .svg exporté, "nom_de_fichier" étant le nom transmis à la commande pour le fichier, sans l'extension. Les images ne sont pas intégrées, mais sont référencées dans le fichier .svg.
  • Note : Si le dossier existe déjà, il est vidé avant l'exportation du fichier. S'il n'y a pas d'image sur la page exportée, le dossier est supprimé
    wk factur xfacturXPour l'exportation PDF uniquement. Valeur : objet configurant une exportation PDF "Factur-X (ZUGFeRD)" (voir Objet wk factur x).
    wk filesHistoriquePour l'exportation PDF uniquement. Valeur : collection d'objets, chacun d'entre eux décrivant un fichier à intégrer dans le document final (voir wk files collection). Cette fonctionnalité n'est prise en charge que dans les documents PDF/A-3 : lorsque l'attribut wk files est utilisé, la version "PDF/A-3" est automatiquement définie (l'attribut wk pdfa version est ignoré). Dans le cas d'un export PDF Factur-X (voir ci-dessous), le premier objet de la collection doit contenir le fichier xml Factur-X.
    wk google fonts taggoogleFontsTagPour l'exportation SVG uniquement. Définit la règle d'importation des polices google dans le SVG exporté. Valeurs possibles :
  • false (par défaut) : Aucune règle d'importation des polices de Google n'est ajoutée.
  • true : Ajoute la règle @import au fichier exporté. Utile si vous voulez utiliser des polices qui ne sont pas disponibles par défaut sur Windows ou macOS.
  • Note: Cette propriété est définie sur false par défaut car, lorsqu'elle est activée, les polices Google ont la priorité sur les polices natives, et ces dernières sont généralement mieux rendues dans le navigateur.
    wk HTML pretty printhtmlPrettyPrintLe code HTML est formaté pour être plus facile à lire.
    wk max picture DPImaxPictureDPIUtilisé pour rééchantillonner (réduire) les images à la résolution souhaitée. Pour les images SVG dans Windows, utilisé pour le tramage. Valeurs par défaut : 300 (pour wk optimized for = wk print) 192 (pour wk optimized for = wk screen) Valeur maximale possible : 1440
    wk optimized foroptimizedForDéfinit la manière dont un document exporté est optimisé en fonction du media auquel il est destiné. Valeurs possibles :
  • wk print (valeur par défaut pour wk pdf et wk svg) Les images bitmap peuvent être réduites en utilisant le DPI défini par wk max picture DPI ou 300 (valeur par défaut) et peuvent être converties en PNG si le codec n'est pas pris en charge pour le type d'exportation. Les images vectorielles sont converties en PNG en utilisant le DPI défini par wk max picture DPI ou 300 (Windows uniquement). Si une image contient plus d'un format, le meilleur format pour l'impression est utilisé (e.g., .tiff au lieu de .jpg)
  • wk screen (valeur par défaut pour wk web page complete et wk mime html). Les images bitmap peuvent être réduites en utilisant le DPI défini par wk max picture DPI ou 192 (valeur par défaut) et peuvent être converties en JPEG (images opaques) ou PNG (images transparentes) si le codec n'est pas pris en charge pour le type d'exportation. Les images vectorielles sont converties en PNG en utilisant le DPI défini par wk max picture DPI ou 192 (Windows uniquement). Si une image contient plus d'un format, le format de rendu d'écran est utilisé.
  • Note: Les documents exportés au format wk docx sont toujours optimisés pour wk print (l'option wk optimized for est ignorée).
    wk page indexpageIndexPour l'exportation SVG uniquement. Indice de la page à exporter au format svg (1 par défaut). L'indice des pages commence à 1 pour la première page du document. Note : L'indice des pages est indépendant de la numérotation des pages.
    wk pdfa versionpdfaVersionExporte des PDF conformes à une version PDF/A. Pour plus d'informations sur les propriétés et les versions du PDF/A, veuillez consulter la page PDF/A sur Wikipedia. Valeurs possibles :
  • wk pdfa2 : Exporte en version "PDF/A-2"
  • wk pdfa3 : Exporte en version "PDF/A-3"
  • Note: Sous macOS, wk pdfa2 peut exporter vers PDF/A-2 ou PDF/A-3 ou plus, selon l'implémentation de la plateforme. Aussi, wk pdfa3 signifie "exporte vers au moins PDF/A-3". Sous Windows, le fichier PDF de sortie sera toujours égal à la conformité souhaitée.
  • wk recompute formulasrecomputeFormulasDéfinit si les formules doivent être recalculées lorsqu'elles sont exportées. Valeurs possibles :
  • true - Valeur par défaut. Toutes les formules sont recalculées
  • false - Ne pas recalculer les formules
  • wk visible background and anchored elementsvisibleBackgroundAffiche ou exporte les images/couleurs d'arrière-plan, les images ancrées et les zones de texte (pour l'affichage, effet visible en mode d'affichage Page ou Inclus uniquement). Valeurs possibles : True/False
    wk visible empty imagesvisibleEmptyImagesAffiche ou exporte un rectangle noir par défaut pour les images qui ne peuvent pas être chargées ou calculées (images vides ou images dans un format non pris en charge). Valeurs possibles : True/False. Valeur par défaut : Vrai. Si la valeur est False, les éléments d'image manquants ne seront pas affichés du tout, même s'ils ont des bordures, une largeur, une hauteur ou un arrière-plan ; cela peut avoir un impact sur la mise en page pour les images en ligne.
    wk visible footersvisibleFootersAffiche ou exporte les pieds de page (pour l'affichage, effet visible en mode Page uniquement). Valeurs possibles : True/False
    wk visible headersvisibleHeadersAffiche ou exporte les en-têtes (pour l'affichage, effet visible en mode Page uniquement). Valeurs possibles : True/False
    wk visible referencesvisibleReferencesAffiche ou exporte toutes les expressions 4D insérées dans le document en tant que références. Valeurs possibles : True/False
    wk whitespacewhitespaceDéfinit la valeur css "white-space" pour le format d'exportation wk mime html. Le style white-space css est appliqué aux paragraphes. Valeurs possibles : "normal", "nowrap", "pre", "pre-wrap" (par défaut), "pre-line", "break-spaces".

    Le tableau suivant indique l'option disponible par format d'export :

    wk 4wpwk docxwk mime htmlwk pdfwk web page html 4dwk svg
    wk CID host domain name-----
    wk embedded pictures----- (par défaut : true)
    wk factur x-----
    wk files-----
    wk google fonts tag----- (par défaut : false)
    wk HTML pretty print (par défaut : false)- (par défaut : False) (par défaut : False) (par défaut : False) (par défaut : false)
    wk max picture DPI-toujours 300 (par défaut : 300)- (par défaut : 300)
    wk optimized for-toujours wk print (default: wk screen)toujours wk print- (par défaut : wk print)
    wk page index----- (par défaut : 1)
    wk pdfa version-----
    wk recompute formulas- (par défaut : true) (par défaut : true) (par défaut : true)- (par défaut : true)
    wk visible background and anchored elements- (par défaut : true)toujours true (par défaut : true)- (par défaut : true)
    wk visible empty images- (par défaut : true) (par défaut : true) (par défaut : true)- (par défaut : true)
    wk visible footers-toujours truetoujours false (par défaut : true)- (par défaut : true)
    wk visible headers-toujours truetoujours false (par défaut : true)- (par défaut : true)
    wk visible references--- (par défaut : false)- (par défaut : false)
    wk whitespace-- (par défaut : "pre-wrap")---

    Note de compatibilité : Passer une valeur longint dans option est pris en charge pour des raisons de compatibilité, mais il est recommandé d'utiliser un paramètre objet.

    Exemple 1

    Vous voulez exporter le contenu de l'objet myArea 4D Write Pro au format MIME et ajouter "gmail.com" comme domaine hôte :

     var $option;$export : Object

    $option[wk CID host domain name]:="gmail.com"

    WP EXPORT VARIABLE(myArea;$export;wk mime html;$option)

    Exemple 2

    Vous voulez envoyer un email contenant du texte stylé, des références 4D et des images. Vous pouvez utiliser une zone 4D Write Pro exportée au format MIME et envoyée en utilisant SMTP:

      // créer le transporteur
    $server:=New object
    $server.host:="smtp.gmail.com"
    $server.port:=465
    $server.user:="4D@gmail.com"
    $server.password:="XXXX"

    $transporter:=SMTP New transporter($server)

    WP EXPORT VARIABLE(WParea;$mime;wk mime html)

    $mailTmp:=MAIL Convert from MIME($mime)

    // ajouter des photos (le cas échéant)
    If($mailTmp.attachments#Null)
    $email.attachments:=$mailTmp.attachments
    End if

    $email.bodyStructure:=$mailTmp.bodyStructure
    $email.bodyValues:=$mailTmp.bodyValues

    $status:=$transporter.send($email)
    If(Not($status.success))
    ALERT("An error occurred: "+$status.statusText)
    End if

    Exemple 3

    Pour exporter la première page d'un 4D Write Pro en SVG dans une variable Texte et masquer les en-têtes :

     var $options : Object
    var $destination : Text

    $options:=New object
    $options[wk optimized for]:=wk screen
    $options[wk visible headers]:=False
    WP EXPORT VARIABLE(WPArea;$destination;wk svg;$options)

    Voir également

    4D QPDF (Component) - PDF Get attachments
    Blog post - 4D Write Pro : Génération de factures électroniques
    Blog post - 4D Write Pro : Export au format PDF avec pièces jointes
    Exporter aux formats HTML et MIME HTML
    Importer et exporter au format docx
    WP EXPORT DOCUMENT