メインコンテンツまでスキップ
バージョン: 21

WP EXPORT VARIABLE

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

引数型説明
wpDocObject→4D Write Pro 変数
destinationText, Blob→書き出したコンテンツを受け取る引数
formatInteger→変数出力フォーマット
optionObject, Integer→書き出しのオプション

説明​

WP EXPORT VARIABLE コマンドはwpDoc 引数で指定した4D Write Pro オブジェクトを、 destination 引数で指定した4D 変数へ、 format 引数で指定したフォーマットで書き出します。

wpDoc 引数には、書き出したい4D Write Pro オブジェクトを渡します。

destination 引数には、書き出した4D Write Pro オブジェクトを受け取る変数を渡します。 この変数の型は、format 引数で指定した書き出しフォーマットによって異なります:

  • ネイティブの.4wp フォーマットまたは.docx フォーマットを渡した場合、変数はBlob 型になります。
  • HTML またはSVG フォーマットを渡した場合、変数はテキスト型になります。

format 引数には、使用したい書き出しフォーマットを設定する、4D Write Pro 定数 テーマの定数を一つ渡します。 それぞれのフォーマットは特定の用法に関連します。 以下のフォーマットがサポートされています:

定数型値説明
wk 4wpInteger44D Write Pro ドキュメントはネイティブなアーカイブフォーマット(圧縮されたHTML で画像は別個のフォルダに保存)で保存されます。 4D 特有のタグは含まれ、4D 式は計算されません。 このフォーマットは特にロスなく4D Write Pro ドキュメントをディスク上に保存するのに適しています。
wk docxInteger7.docx 拡張子を意味します。 4D Write Pro ドキュメントはMicrosoft Word フォーマットで保存されます。 Microsoft Word 2010 以降に正式に対応しています。

書き出しに対応しているドキュメントの部分は以下の通りです::
本文 / ヘッダー / フッター / セクション / ページ / 印刷設定 (余白、背景色 / 背景画像、境界線、パディング、用紙サイズ / 用紙の向き) 画像 - インライン、アンカー、背景画像パターン(wk background image で定義されているもの) 互換性のある変数と式(ページ番号、ページ数、日付、時間、メタデータ)。 互換性のない変数と式は評価されて、書き出しの前に値が固定化されます。 リンク -
ブックマーク URL 一部の4D Write Pro 設定はMicrosoft Word では利用できないか、振る舞いが異なる可能性があることに注意してください。
wk mime htmlInteger14D Write Proドキュメントは標準のMIME HTMLとして保存され、htmlドキュメントと画像はMIMEパーツとして埋め込まれます(base64でエンコードされます)。 式は計算され4D特有のタグやメソッドのリンクは除去されます。 埋め込みビューにアンカーされたテキストボックスのみが(divとして)書き出されます。 このフォーマットは コマンドを使用してHTML Eメールを送信するのに特に適しています。
wk pdfInteger5.pdf 拡張子。 4D Write Pro ドキュメントはページビューモードに基づいてPDF フォーマットで保存されています。 PDF ドキュメントには以下のメタ情報が書き出されています: タイトル 作者 タイトル コンテンツ作成者 注意: 式は、ドキュメントが書き出されるときに自動的に値が計算されて固定化されます。メソッドへのリンクはサポートされていません。
wk svgInteger84D Write Pro ドキュメントのページはページビューモードに基づいてSVG フォマットで保存されます。 注意: SVG へと書き出す際は、一度に1ページしか書き出すことができません。 書き出すページを指定するにはwk page index を使用して下さい。
wk web page html 4DInteger34D Write Pro ドキュメントはHTML として保存さんれ、4D 特有のタグが含まれます。それぞれの式はノンブレーキングスペースとして挿入されます。 このフォーマットはロスレスであるため、テキストフィールドへの保存目的に適しています。

注:

  • "4D 特有のタグ"とは、4Dネームスペースと4D CSSスタイルを含めた4D XHTMLのことです。
  • 4D Write Pro ドキュメントフォーマットに関するより詳細な情報に関しては、.4wp ドキュメントフォーマットを参照してください。
  • .docx フォーマットを使用する際の、既知の差異および非互換性の一覧を見るためには、.docxフォーマットの読み込み/書き出しを参照してください。
  • コマンドを使用してSVG フォーマットへと書き出す場合、画像はbase64 フォーマットでエンコーディングされます。
  • SVG フォーマットへの書き出しの詳細な情報については、 SVGフォーマットへの書き出しを参照してください。

option 引数​

option 引数には、書き出されるドキュメントのプロパティを定義する値を格納しているオブジェクト を渡します。 次のプロパティを利用することができます: 次のプロパティを利用することができます: 次のプロパティを利用することができます:

定数値説明
wk CID host domain namecidHostDomainCID ホストドメイン名: 生成されるCID URL に追加されるホストドメイン。'@' が区切り文字として含まれます。 wk mime html フォーマットが使用されている際にのみ使用可能です。 wk mime html フォーマットが使用されている際にのみ使用可能です。
wk embedded picturesembeddedPicturesSVG 書き出し専用。 WP EXPORT DOCUMENT を呼び出した時、ピクチャーが書き出された.svg ファイル内に埋め込まれるかどうかを設定します。 取り得る値:
  • true (デフォルト): ピクチャーは書き出された.svg ファイルに埋め込まれます。
  • false: ピクチャーは書き出された.svg ファイルと同じ階層にある"filename_images" というフォルダ内に書き出されます。この"filename" はファイル用にコマンドに渡された名前の拡張子を抜いたものです。 ピクチャーは埋め込まれませんが、.svg ファイルから参照されます。
    • 注意: フォルダが既に存在する場合、ファイルが書き出される前にそのフォルダは空にされます。 書き出されたページに画像が何もない場合、フォルダは削除されます。
    wk factur xfacturXPDF 書き出しのみ。 値: "Factur-X (ZUGFeRD)" PDF 書き出しを設定するオブジェクト(wk factur x オブジェクト 参照)。
    wk filesfilesPDF 書き出しのみ。 値：生成されるドキュメントに埋め込まれるファイルを記述したオブジェクトのコレクション(wk files コレクション 参照)。 PDF 添付はPDF/A-3 バージョンでのみサポートされています。wk files プロパティを渡す場合、"PDF/A-3" バージョンが自動的に使用されます(wk pdfa version 属性は無視されます)。 Factur-X PDF 書き出し(下記参照)の場合、コレクションの最初のオブジェクトにはFactur-X XML ファイルが格納されている必要があります。
    wk google fonts taggoogleFontsTagSVG書き出し専用。 書き出されたSVG 内でのGoogle フォントの読み込みルールを設定します。 取り得る値:
  • false (デフォルト): Google フォントの読み込みルールは何も追加されません。
  • true: 書き出されたファイルに@import ルールを追加します。 Windows またはmacOS において利用できないフォントを使用したい場合に有用です。
    • 注意: このプロパティはデフォルトではFalse に設定されています。なぜなら読み込まれたGoogle フォントはネイティブのフォントを上書きしますが、一般的にはネイティブのフォントはブラウザ上で綺麗にレンダリングされるからです。
    wk HTML pretty printhtmlPrettyPrintHTML コードは読みやすいようにフォーマットされます。
    wk max picture DPImaxPictureDPI画像を適切な解像度にリサンプリング(縮小)するのに使用されます。 Windows でのSVG 画像に対しては。ラスタライズに使用されます。 デフォルト値: 300 (for wk optimized for = wk print 時) 192 (for wk optimized for = wk screen 時) 取り得る最大値: 1440
    wk optimized foroptimizedFor書き出されたドキュメントを、その目的に応じてどのように最適化するかを定義します。 取り得る値:
  • wk print (wk pdf および wk svg のデフォルト値) ビットマップピクチャーは、wk max picture DPI で定義されたDPI または300 (デフォルト値) を使用してダウンスケールされる可能性があり、また書き出されるタイプに対してコーデックがサポートされていない場合にはPNG へと変換される可能性もあります。 ベクターのピクチャーは wk max picture DPI で定義されたDPI、または300 (Windows のみ)を使用してPNG へと変換されます。 ピクチャーに複数のフォーマットが含まれている場合、最適なフォーマットが使用されます(例: .jpg の代わりに.tiff など)。
  • wk screen (wk web page complete および wk mime html のデフォルト値)。 ビットマップは wk max picture DPI で定義されたDPI または192 (デフォルト値) を使用してダウンスケールされる可能性があり、また書き出しタイプに対してコーデックがサポートされていない場合にはJPG (透過部分のない画像) またはPNG (透過画像) へと変換されます。 ベクターのピクチャーは wk max picture DPI で定義されたDPI、または192 (Windows のみ)を使用してPNG へと変換されます。 画像に複数のフォーマットが含まれている場合、スクリーンレンダリング用のフォーマットが使用されます。
    • 注意: wk docx フォーマットで書き出されたドキュメントは、常にwk print 用に最適化されています(wk optimized for オプションは無視されます)。
    wk page indexpageIndexSVG書き出し専用。 SVG書き出し専用。 SVG フォーマットへと書き出すページのインデックス(デフォルトは1)。 ページのインデックスは1から始まり、これはドキュメントの最初のページを指します。 注意: ページインデックスはページナンバリングとは異なるものです。 ページのインデックスは1から始まり、これはドキュメントの最初のページを指します。 注意: ページインデックスはページナンバリングとは異なるものです。
    wk pdfa versionpdfaVersionPDF/A バージョンに適合したPDF を書き出します。 PDF/A のプロパティおよびバージョンの詳細については、Wikipedia のPDF/A のページ を参照してください。 取り得る値:
  • wk pdfa2: "PDF/A-2" バージョンに書き出します。
  • wk pdfa3: "PDF/A-3" バージョンに書き出します。
  • 注意: macOS 上では、プラットフォームの実装によってはwk pdfa2 定数はPDF/A-2 またはPDF/A-3 またはそれ以上のバージョンに書き出すことがあります。 また、wk pdfa3 定数は"少なくとも PDF/A-3へと書き出す"ということを意味します。 Windows 上では、出力されたPDF ファイルは常に指定されたバージョンと同じになります。
    • wk recompute formulasrecomputeFormulas書き出し時にフォーミュラを再計算するかどうかを定義します。 取り得る値:
  • true - デフォルト値。 全てのフォーミュラは再度計算されます。
  • false- フォーミュラを再計算しません。
    • wk visible background and anchored elementsvisibleBackground背景画像/背景色、アンカーされた画像またはテキストボックス(ディスプレイ用では、ページビューモードまたは埋め込みビューモードでのみ表示されるエフェクト)を表示または書き出しをします。 取り得る値: True/False 取り得る値: True/False 取り得る値: True/False
    wk visible empty imagesvisibleEmptyImages読み込めない、あるいは計算できない画像(空の画像またはサポートされていないフォーマットの画像)に対してデフォルトの黒い四角形を表示または書き出しします。 取り得る値: True/False. 取り得る値: True/False. デフォルト値: True 値がFalse の場合、たとえ画像に境界線、幅、高さ、背景などが設定されてあっても空の画像要素は全く表示されないという点に注意して下さい。これはインライン画像のページレイアウトに影響する可能性があります。
    wk visible footersvisibleFootersフッターを表示または書き出しします(表示用においてはページビューモードでのみ表示されるエフェクトです)。 取り得る値: True/False 取り得る値: True/False
    wk visible headersvisibleHeadersヘッダーを表示または書き出しします(表示用においてはページビューモードでのみ表示されるエフェクトです)。 取り得る値: True/False 取り得る値: True/False 取り得る値: True/False
    wk visible referencesvisibleReferencesドキュメントに挿入されている4D 式を参照として表示または書き出しします。 取り得る値: True/False
    wk whitespacewhitespacewk mime html 書き出しフォーマットに対する"white-space" CSS 値を設定します。 white-space CSS スタイル は段落に対して適用されます。 取り得る値: "normal"、"nowrap"、 "pre"、 "pre-wrap" (デフォルト)、 "pre-line"、 "break-spaces"

    以下の表はformat 引数の各フォーマットごとに利用可能なoption 引数のオプションをあらわしています:

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

    互換性に関する注意: option 引数に倍長整数 型の値を渡すことは互換性の理由からサポートされていますが、オブジェクト型 型の引数を渡すことが推奨されています。

    例題 1​

    myArea 4D Write Pro オブジェクトの中身をMIME フォーマットで書き出し、"gmail.com" をホストドメインとして追加したい場合を考えます:

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

    例題 2​

    スタイル付きテキスト、4D 参照および画像を格納したEメールを送信したい場合を考えます。 この場合、MIME フォーマットで書き出された4D Write Pro エリアを使用し、SMTP を使用して送信することができます:

      // transporter オブジェクトを作成
     $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)
     
      // ピクチャーを追加(あれば)
     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

    例題 3​

    4D Write Pro の最初のページをテキスト変数内のSVG として書き出して、ヘッダーを非表示にしたい場合を考えます:

     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)

    参照​

    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