バージョン: 20 R8 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		テキスト	(optional) When present, designates the exported file format: ".4vp" (default), ".csv", ".xlsx", ".pdf", or ".sjs". You can use the following constants: `vk 4D View Pro format` `vk csv format` `vk MS Excel format` `vk pdf format` `vk sjs format` 4D adds the appropriate extension to the file name if needed. If the format specified doesn't correspond with the extension in filePath, it will be added to the end of filePath. If a format is not specified and no extension is provided in filePath, the default file format is used.
password		テキスト	Microsoft Excel のみ (任意) - MS Excel ドキュメントの保護に使用されるパスワード。
formula		4D.Function	書き出しが完了した際に呼び出されるコールバックメソッド名。書き出しが非同期でおこなわれる (PDF および Excel 形式での書き出しが該当します) 場合かつ、書き出し後にコードを実行したい場合には、コールバックメソッドが必要です。 The callback method must be passed with the `Formula` command. See Passing a callback method (formula).
valuesOnly		boolean	フォーミュラ (あれば) の値のみを書き出すかどうかを指定します。
includeFormatInfo		boolean	フォーマット (書式) 情報を含めるには true、それ以外の場合には false (デフォルトは true)。フォーマット情報は特定の場合 (例: SVGへの書き出しなど) において有用です。 On the other hand, setting this property to false allows reducing export time.
includeBindingSource		boolean	4DVP および Microsoft Excel のみ。 true (デフォルト) の場合、カレントデータコンテキストの値を、書き出したドキュメントのセルの値としてエクスポートします (データコンテキスト自体はエクスポートされません)。それ以外は false。セルバインドは常にエクスポートされます。 For data context and cell binding management, see VP SET DATA CONTEXT and VP SET BINDING PATH.
sheetIndex		number	PDF のみ (任意) - 書き出すシートのインデックス (0 起点)。 -2=all visible sheets (default), -1=current sheet only
pdfOptions		object	PDF only (optional) - Options for pdf
	creator	テキスト	変換されたドキュメントの変換元を作成したアプリケーション名。
	title	テキスト	ドキュメント名。
	author	テキスト	ドキュメントの作成者の名前。
	keywords	テキスト	ドキュメントに割り当てられたキーワード。
	subject	テキスト	ドキュメントの題名。
csvOptions		object	CSVのみ (任意) - csv 書き出しのオプション
	range	object	複数セルのレンジオブジェクト
	rowDelimiter	テキスト	行の区切り文字。 Default: `"\r\n"`
	columnDelimiter	テキスト	カラムの区切り文字。 Default: `","`
sjsOptions		object	SJS only (optional) - Options for sjs export
	includeAutoMergedCells	boolean	whether to include the automatically merged cells, default is false.
	includeBindingSource	boolean	whether to include the binding source, default is true.
	includeCalcModelCache	boolean	whether to include the extra data of calculation. Can be faster when open the file with those data, default is false.
	includeEmptyRegionCells	boolean	whether to include any empty cells (cells with no data or only style) outside the used data range, default is true.
	includeFormulas	boolean	whether to include the formulas, default is true.
	includeStyles	boolean	whether to include the style, default is true.
	includeUnusedNames	boolean	whether to include the unused custom names, default is true.
	saveAsView	boolean	whether to apply the format string to exporting values, default is false.
excelOptions		object	Excel only (optional) - Options for Excel export
	includeBindingSource	boolean	Whether to include the binding source when exporting, default false.
	includeStyles	boolean	Whether to include the style when exporting, default true.
	includeFormulas	boolean	Whether to include the formula when exporting, default true.
	saveAsView	boolean	Whether to apply the format string to exporting value when exporting, default false.
	rowHeadersAsFrozenColumns	boolean	Whether to treat the row headers as frozen columns when exporting, default false.
	columnHeadersAsFrozenRows	boolean	Whether to treat the column headers as frozen rows when exporting, default false.
	includeAutoMergedCells	boolean	Whether to include the automatically merged cells when exporting, default false.
	includeCalcModelCache	boolean	計算の追加データを含めるか。 Can be faster when open the file with those data, default false.
	includeUnusedNames	boolean	Whether to include the unused custom name when exporting, default true.
	includeEmptyRegionCells	boolean	Whether to include any empty cells(cells with no data or only style) outside the used data range, default true.
	password	テキスト	Password to set to open the workbook.
`\<customProperty>`		any	コールバックメソッドの $3 引数を通して利用可能な任意のプロパティ。

Excel 形式についての注意:

4D View Pro ドキュメントを Microsoft Excel 形式のファイルに書き出す場合、一部の設定が失われる可能性があります。たとえば、4Dメソッドとフォーミュラは Excel ではサポートされません。 SpreadJS にある一覧にて、その他の設定を確認することができます。
このフォーマットへの書き出しは非同期に実行されるため、書き出し後にコードを実行するには、paramObj 引数の formula プロパティを使用します。
Using excelOptions object is recommended when exporting in ".xlsx" format. Make sure to not mix this object with legacy first level properties (password, includeBindingSource...) to avoid potiental issues.

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

例題 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:={}
$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 で開くメソッドを呼び出します:

 var $params:={}
 $params.formula:=Formula(AfterExport)
 $excelOptions:={includeStyles:false;includeFormulas:true}
 $params.excelOptions:=$excelOptions
 VP EXPORT DOCUMENT("ViewProArea";"c:\\tmp\\convertedfile.xlsx";$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:={}
$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
4D View Pro: Excel import/export update (blog post)

説明​

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

例題 1​

例題 2​

例題 3​

例題 4​

参照​

説明

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

例題 1

例題 2

例題 3

例題 4

参照