バージョン: 20 R6 BETA

VP EXPORT DOCUMENT

履歴

リリース	内容
20 R2	.sjsドキュメントをサポート

VP EXPORT DOCUMENT ( vpAreaName : Text ; filePath : Text {; paramObj : Object} )

引数	型		説明
vpAreaName	Text	->	4D View Pro フォームオブジェクト名
filePath	Text	->	ドキュメントのパス名
paramObj	Object	->	書き出しのオプション

説明

VP EXPORT DOCUMENT コマンドは、vpAreaName で指定した 4D View Pro エリアに関連付けられている 4D View Pro オブジェクトを、filePath と paramObj で指定したとおりにディスク上のドキュメントに書き出します。

vpAreaName には、4D View Pro エリアの名前を渡します。存在しない名前を渡した場合、エラーが返されます。

filePath には書き出すドキュメントのパスとファイル名を渡します。パスを指定しない場合、ドキュメントは Projectフォルダーと同階層に保存されます。

ドキュメント名に拡張子を付けることで、書き出すドキュメントの形式を指定することができます:

4D View Pro (".4vp")
Microsoft Excel (".xlsx")
PDF (".pdf")
CSV (".txt" または ".csv")
SpreadJS ドキュメント (".sjs")

ファイル名に拡張子が含まれていなくても、paramObj 引数によって形式が指定されている場合、書き出されたファイルには形式に対応する拡張子がつけられます。ただし CSV形式の場合には拡張子がつきません。

任意の paramObj 引数を渡すと、書き出される 4D View Pro オブジェクトの複数のプロパティに加えて、書き出しが完了した際に呼び出されるコールバックメソッド名を定義することができます。

プロパティ型説明

format text (任意) 渡した場合、書き出されるファイルの形式を指定します: ".4VP" (デフォルト)、 ".csv"、".xlsx"、 ".pdf"、または ".sjs"。次の定数が利用できます:
vk 4D View Pro format
vk csv format
vk MS Excel format
vk pdf format
vk sjs format
4D は必要に応じて適切な拡張子をファイル名に追加します。指定した形式が filePath 引数として渡された拡張子と合致しない場合、指定形式の拡張子は filePath 引数の後ろに追加されます。形式が指定されず、filePath 引数にも拡張子がなかった場合には、デフォルトのファイル形式が使用されます。

password text Microsoft Excel のみ (任意) - MS Excel ドキュメントの保護に使用されるパスワード。

formula 4D.Function 書き出しが完了した際に呼び出されるコールバックメソッド名。書き出しが非同期でおこなわれる (PDF および Excel 形式での書き出しが該当します) 場合かつ、書き出し後にコードを実行したい場合には、コールバックメソッドが必要です。コールバックメソッドは Formula コマンドを使って渡す必要があります。コールバックメソッドの渡し方を参照ください。

valuesOnly boolean フォーミュラ (あれば) の値のみを書き出すかどうかを指定します。

includeFormatInfo boolean フォーマット (書式) 情報を含めるには true、それ以外の場合には false (デフォルトは true)。フォーマット情報は特定の場合 (例: SVGへの書き出しなど) において有用です。一方で、このプロパティを false に設定することで書き出し時間を短縮することもできます。

includeBindingSource boolean 4DVP および Microsoft Excel のみ。 true (デフォルト) の場合、カレントデータコンテキストの値を、書き出したドキュメントのセルの値としてエクスポートします (データコンテキスト自体はエクスポートされません)。それ以外は false。セルバインドは常にエクスポートされます。データコンテキストおよびセルバインドの管理については、VP SET DATA CONTEXT および VP SET BINDING PATH を参照ください。

sheetIndex number PDF のみ (任意) - 書き出すシートのインデックス (0 起点)。 -2 = 表示されている全シート (デフォルト)、-1 = カレントシートのみ

pdfOptions

object

PDFのみ (任意) - pdf 書き出しのオプション

プロパティ	タイプ	説明
creator	text	変換されたドキュメントの変換元を作成したアプリケーション名。
title	text	ドキュメント名。
author	text	ドキュメントの作成者の名前。
keywords	text	ドキュメントに割り当てられたキーワード。
subject	text	ドキュメントの題名。

csvOptions

object

CSVのみ (任意) - csv 書き出しのオプション

プロパティ	タイプ	説明
range	object	複数セルのレンジオブジェクト
rowDelimiter	text	行の区切り文字。デフォルト: `"\r\n"`
columnDelimiter	text	カラムの区切り文字。デフォルト: `","`

sjsOptions

object

SJSのみ (任意) - sjs 書き出しのオプション

プロパティ	タイプ	説明
includeAutoMergedCells	boolean	自動的に結合されたセルを含めるかどうか。デフォルトは false。
includeBindingSource	boolean	バインドされたソースを含めるかどうか。デフォルトは true。
includeCalcModelCache	boolean	計算の追加データを含めるか。追加データによって、ファイルを開くのが速くなる場合があります。デフォルトは false。
includeEmptyRegionCells	boolean	使用されるデータレンジの外側の空白セル (データがない、またはスタイルだけのセル) を含めるかどうか。デフォルトは true。
includeFormulas	boolean	フォーミュラを含めるかどうか。デフォルトは true。
includeStyles	boolean	スタイルを含めるかどうか。デフォルトは true。
includeUnusedNames	boolean	使用されていないカスタム名を含めるかどうか。デフォルトは true。
saveAsView	boolean	書き出される値にフォーマット文字列を適用するかどうか。デフォルトは false。

\<customProperty> any コールバックメソッドの $3 引数を通して利用可能な任意のプロパティ。

Excel 形式についての注意:

4D View Pro ドキュメントを Microsoft Excel 形式のファイルに書き出す場合、一部の設定が失われる可能性があります。たとえば、4Dメソッドとフォーミュラは Excel ではサポートされません。 SpreadJS にある一覧にて、その他の設定を確認することができます。
このフォーマットへの書き出しは非同期に実行されるため、書き出し後にコードを実行するには、paramObj 引数の formula プロパティを使用します。

PDF 形式についての注意:

4D View Pro ドキュメントを PDF 形式に書き出す場合、ドキュメントで使用されているフォントは自動的に PDF ファイルに埋め込まれます。ただし、埋め込み可能なのは Unicode マップを持つ OpenType フォント (.OTF または .TTF ファイル) のみです。フォントに対して有効なフォントファイルが見つからない場合、デフォルトのフォントが代用されます。
このフォーマットへの書き出しは非同期に実行されるため、書き出し後にコードを実行するには、paramObj 引数の formula プロパティを使用します。

CSV 形式についての注意:

4D View Pro ドキュメントを CSV 形式に書き出す場合、テキストと値のみが保存されるため、一部の設定が失われる可能性があります。
すべての値は二重引用符で括られた形で保存されます。ユーザー定義区切りの値 (DSV) に関する詳細については、こちらの Wikipedia の記事 (英文) を参照ください。
このフォーマットへの書き出しは非同期に実行されるため、書き出し後にコードを実行するには、paramObj 引数の formula プロパティを使用します。

SpreadJS ファイル形式についての注意:

SpreadJS ファイルは zipファイルです。
このフォーマットへの書き出しは非同期に実行されるため、書き出し後にコードを実行するには、paramObj 引数の formula プロパティを使用します。

書き出し操作が完了すると、VP EXPORT DOCUMENT は自動的に、paramObj オブジェクトの formula プロパティに設定されたメソッドをトリガーします (設定されていれば)。

コールバックメソッド (フォーミュラ) の渡し方

コマンドに任意の paramObj 引数を渡す場合、Formula コマンドを使って、書き出し完了時に実行される 4Dメソッドを呼び出すことができます。コールバックメソッドは、以下の値をローカルパラメーターに受け取ります:

引数		型	説明
param1		text	4D View Pro エリアのオブジェクト名
param2		text	書き出された 4D View Pro オブジェクトのファイルパス
param3		object	コマンドの paramObj 引数への参照
param4		object	メソッドから返されるステータスメッセージを格納したオブジェクト
	.success	boolean	書き出しに成功した場合は true 、それ以外の場合は false
	.errorCode	integer	エラーコード。
	.errorMessage	text	エラーメッセージ。

例題 1

"VPArea" エリアのコンテンツをディスク上の 4D View Pro ドキュメントに書き出します:

var $docPath: Text

$docPath:="C:\\Bases\\ViewProDocs\\MyExport.4VP"
VP EXPORT DOCUMENT("VPArea";$docPath)
// MyExport.4VP がディスク上に保存されます

例題 2

カレントシートを PDF に書き出します:

var $params: Object
$params:=New object
$params.format:=vk pdf format
$params.sheetIndex:=-1
$params.pdfOptions:=New object("title";"Annual Report";"author";Current user)
VP EXPORT DOCUMENT("VPArea";"report.pdf";$params)

例題 3

4D View Pro ドキュメントを ".xlsx" 形式に書き出して、書き出し完了後にそのドキュメントをMicrosoft Excel で開くメソッドを呼び出します:

 $params:=New object
 $params.formula:=Formula(AfterExport)
 $params.format:=vk MS Excel format //".xlsx"
 $params.valuesOnly:=True

 VP EXPORT DOCUMENT("ViewProArea";"c:\\tmp\\convertedfile";$params)

AfterExport メソッド:

 #DECLARE($areaName : Text ; $filePath : Text ; $params : Object ; $status : Object )

 If($status.success=False)
    ALERT($status.errorMessage)
 Else
    LAUNCH EXTERNAL PROCESS("C:\\Program Files\\Microsoft Office\\Office15\\excel "+$filePath)
 End if

例題 4

カレントシートを、縦棒 (|) 区切りの .txt ファイルに書き出します:

example-export-csv

var $params : Object
$params:=New object
$params.range:=VP Cells("ViewProArea";0;0;2;5)
$params.rowDelimiter:="\n"
$params.columnDelimiter:="|"
VP EXPORT DOCUMENT("ViewProArea";"c:\\tmp\\data.txt";New object("format";vk csv format;"csvOptions";$params))

このようになります:

example-export-csv

参照

VP Convert to picture
VP Export to object
VP IMPORT DOCUMENT
VP Print

説明​

コールバックメソッド (フォーミュラ) の渡し方​

例題 1​

例題 2​

例題 3​

例題 4​

参照​

説明

コールバックメソッド (フォーミュラ) の渡し方

例題 1

例題 2

例題 3

例題 4

参照