Saltar al contenido principal
Versión: Siguiente

WP EXPORT VARIABLE

WP EXPORT VARIABLE ( wpDoc ; destination ; format {; option} )

ParámetrosTipoDescripción
wpDocObject→Variable 4D Write Pro
destinationText, Blob→Variable para recibir los contenidos exportados
formatInteger→Formato de salida variable
optionObject, Integer→Opciones de exportación

Descripción​

The WP EXPORT VARIABLE command exports the wpDoc 4D Write Pro object to the 4D destination variable in the specified format.

En wpDoc, pase el objeto 4D Write Pro que desea exportar.

In destination, pass the variable that you want to fill with the exported 4D Write Pro object. The type of this variable depends on the export format specified in the format parameter:

  • If you pass the native .4wp format or the .docx format, the variable will be of the Blob type,
  • If you pass an HTML or SVG format, the variable will be of the Text type.

In the format parameter, pass a constant from the 4D Write Pro Constants theme to set the export format you want to use. Cada formato está relacionado con un uso específico. Se soportan los siguientes formatos:

ConstanteTipoValorComentario
wk 4wpInteger44D Write Pro document is saved in a native archive format (zipped HTML and images saved in a separate folder). 4D specific tags are included and 4D expressions are not computed. This format is particularly suitable for saving and archiving 4D Write Pro documents on disk without any loss.
wk docxInteger7Extensión .docx. El documento 4D Write Pro se guarda en formato Microsoft Word. Certified support for Microsoft Word 2010 and newer.

The document parts exported are:
Body / headers / footers / sectionsPage / print settings (margins, background color / image, borders, padding, paper size / orientation)Images - inline, anchored, and background image pattern (defined with wk background image)Compatible variables and expressions (page number, number of pages, date, time, metadata). Non-compatible variables and expressions will be evaluated and frozen before export.Links -
BookmarksURLsNote that some 4D Write Pro settings may not be available or may behave differently in Microsoft Word.
wk mime htmlInteger14D Write Pro document is saved as standard MIME HTML with HTML documents and images embedded as MIME parts (encoded in base64). Expressions are computed and 4D specific tags and method links are removed. Only text boxes anchored to embedded view are exported (as divs). This format is particularly suitable for sending HTML emails with the command.
wk pdfInteger5extensión .pdf. 4D Write Pro document is saved in PDF format, based on Page view mode. The following metadata is exported in a PDF document: Title Author Subject Content creator Notes: Expressions are automatically frozen when document is exported Links to methods are NOT exported
wk svgInteger84D Write Pro document page is saved in SVG format, based on Page view mode. Note: When exporting to SVG, you can only export one page at a time. Utilice el wk page index para especificar qué página exportar.
wk web page html 4DInteger34D Write Pro document is saved as HTML and includes 4D specific tags; each expression is inserted as a non-breaking space. Since this format is lossless, it is appropriate for storing purposes in a text field.

Notas:

  • "4D specific tags" means 4D XHTML with a 4D namespace and 4D CSS styles.
  • Para más información sobre el formato de documento 4D Write Pro, consulte el formato del documento .4wp.
  • To view a list of known differences or incompatibility when using the .docx format, see Importing and Exporting in .docx format.
  • When exporting to SVG format with this command, images are embedded in base64 format.
  • For more information on exporting to SVG format, see Exporting to SVG format.

Parámetro option​

Pase un objeto en option conteniendo los valores para definir las propiedades del documento exportado. Las siguientes propiedades están disponibles:

ConstanteValorComentario
wk CID host domain namecidHostDomainCID host domain name: host domain that will be added to generated CID URLs including an '@' as separator. Disponible sólo cuando se utiliza el formato wk mime html.
wk embedded picturesembeddedPicturesSólo para exportación SVG. Sets whether pictures are embedded in the exported .svg file when you call WP EXPORT DOCUMENT. Available values:
  • true (default): Pictures are embedded in the exported .svg file
  • false: Pictures are exported in a folder called "filename_images" at the level of the exported .svg file, "filename" being the name passed to the command for the file, without the extension. The pictures are not embedded, but referenced in the .svg file.
    • Note: If the folder already exists, it is emptied before the file is exported. If there is no image on the exported page, the folder is deleted
    wk factur xfacturXSólo para exportación en PDF. Value: object configuring a "Factur-X (ZUGFeRD)" PDF export (see wk factur x object).
    wk filesHistóricoSólo para exportación en PDF. Valor: colección de objetos, cada uno de los cuales describe un archivo que se integrará en el documento final (ver wk files collection). Esta funcionalidad sólo se admite en documentos PDF/A-3: cuando se utiliza el atributo wk files, se establece automáticamente la versión "PDF/A-3" (se ignora el atributo wk pdfa version). In case of a Factur-X PDF export (see below), the first object of the collection must contain the Factur-X xml file.
    wk google fonts taggoogleFontsTagSólo para exportación SVG. Sets the import rule for google fonts in the exported SVG. Possible values:
  • false (default): No google fonts import rule is added.
  • true: Adds the @import rule to the exported file. Useful if you want to use fonts that are not available by default on Windows or macOS.
    • Note: This property is set to false by default because when enabled, Google fonts override native fonts, and native fonts are generally better rendered in the browser.
    wk HTML pretty printhtmlPrettyPrintEl código HTML está formateado para facilitar su lectura.
    wk max picture DPImaxPictureDPISe utiliza para reducir imágenes a la resolución preferida. For SVG images in Windows, used for rasterization. Default values: 300 (for wk optimized for = wk print) 192 (for wk optimized for = wk screen) Maximum possible value: 1440
    wk optimized foroptimizedForDefines how an exported document is optimized based on its intended medium. Valores posibles:
  • wk print (valor por defecto para wk pdf y wk svg) Las imágenes de mapa de bits pueden reducirse utilizando los PPP definidos por wk max picture DPI o 300 (valor por defecto) y pueden convertirse a PNG si el códec no es compatible con el tipo de exportación. Las imágenes vectoriales se convierten a PNG utilizando los PPP definidos por wk max picture DPI o 300 (sólo Windows). If a picture contains more than one format, the best format for printing is used (e.g., .tiff instead or .jpg)
  • wk screen (default value for wk web page complete and wk mime html). Bitmap pictures may be downscaled using the DPI defined by wk max picture DPI or 192 (default value) and may be converted to JPEG (opaque images) or PNG (transparent images) if codec is not supported for the export type. Vectorial pictures are converted to PNG using the DPI defined by wk max picture DPI or 192 (Windows only). If a picture contains more than one format, the format for screen rendering is used.
    • Note: Documents exported in wk docx format are always optimized for wk print (wk optimized for option is ignored).
    wk page indexpageIndexSólo para exportación SVG. Índice de la página a exportar a formato svg (por defecto es 1). El índice de páginas comienza en 1 para la primera página del documento. Nota: el índice de páginas es independiente de la numeración de páginas.
    wk pdfa versionpdfaVersionExporta PDF conforme a una versión PDF/A. For more information on PDF/A properties and versions, please refer to the PDF/A page on Wikipedia. Possible values:
  • wk pdfa2: Exports to version "PDF/A-2"
  • wk pdfa3: Exports to version "PDF/A-3"
  • Note: On macOS, wk pdfa2 may export to PDF/A-2 or PDF/A-3 or higher, depending on platform implementation. Además, wk pdfa3 significa "exporta a al menos PDF/A-3". On Windows, the output PDF file will always be equal to the desired conformance.
    • wk recompute formulasrecomputeFormulasDefines if formulas must be recomputed when exported. Valores posibles:
  • true - Valor por defecto. All formulas are recomputed
  • false - Do not recompute formulas
    • wk visible background and anchored elementsvisibleBackgroundDisplays or exports background images/color, anchored images and text boxes (for display, visible effect in Page or Embedded view mode only). Valores posibles: True/False
    wk visible empty imagesvisibleEmptyImagesDisplays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Valores posibles: True/False. Default value: True If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images.
    wk visible footersvisibleFootersDisplays or exports the footers (for display, visible effect in Page view mode only). Valores posibles: True/False
    wk visible headersvisibleHeadersDisplays or exports the headers (for display, visible effect in Page view mode only). Valores posibles: True/False
    wk visible referencesvisibleReferencesDisplays or exports all 4D expressions inserted in the document as references. Valores posibles: True/False
    wk whitespacewhitespaceSets the "white-space" css value for wk mime html export format. The white-space css style is applied to paragraphs. Possible values: "normal", "nowrap", "pre", "pre-wrap" (default), "pre-line", "break-spaces".

    The following table indicates the option available per export format:

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

    Nota de compatibilidad: pasar un valor largo en longint es compatible por razones de compatibilidad, pero se recomienda usar un parámetro objeto.

    Ejemplo 1​

    You want to export the contents of the myArea 4D Write Pro object in MIME format and add "gmail.com" as the host domain:

     var $option;$export : Object
     
     $option[wk CID host domain name]:="gmail.com"
     
     WP EXPORT VARIABLE(myArea;$export;wk mime html;$option)

    Ejemplo 2​

    You want to send an email containing styled text, 4D references and images. You can use a 4D Write Pro area exported in MIME format and sent using SMTP:

      // crea el transportador
     $server:=New object
     $server.host:="smtp.gmail. om"
     $server.port:=465
     $server.user:="4D@gmail.com"
     $server. assword:="XXX"
     
     $transporter:=SMTP New transporter($server)
     
     WP EXPORT VARIABLE(WParea;$mime;wk mime html)
     
     $mailTmp:=MAIL Convert from MIME($mime)
     
      // añadir imágenes (si las hay)
     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

    Ejemplo 3​

    To export the first page of a 4D Write Pro as SVG in a Text variable and hide the headers:

     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)

    Ver también​

    4D QPDF (Component) - PDF Get attachments
    Blog post - 4D Write Pro: Electronic invoice generation
    Blog post - 4D Write Pro: Export to PDF with enclosures
    Exporting to HTML and MIME HTML formats
    Importing and Exporting in .docx format
    WP EXPORT DOCUMENT