VP EXPORT TO BLOB
VP EXPORT TO BLOB ( vpAreaName : Text ; paramObj : Object )
| Parameter | Type | Description | |
|---|---|---|---|
| vpAreaName | Text | -> | 4D View Pro area form object name |
| paramObj | Object | -> | Export options |
Description
The VP EXPORT TO BLOB command exports the vpAreaName 4D View Pro document in a 4D.Blob according to the paramObj options. The exported blob is available through the export callback. Exporting and importing 4D View Pro areas as blobs is fast and memory-efficient.
In paramObj, you can pass several properties:
| Property | Type | Description |
|---|---|---|
| formula | 4D.Function | (mandatory) Callback method to be launched when the export has completed. See Passing a callback method (formula). |
| includeAutoMergedCells | Boolean | Whether to include the automatically merged cells when saving, default=false. |
| includeBindingSource | Boolean | Whether to include the binding source when saving, default=true. |
| includeCalcModelCache | Boolean | Whether to include the extra data of calculation. Can impact the speed of opening the file, default=false. |
| includeEmptyRegionCells | Boolean | Whether to include any empty cells(cells with no data or only style) outside the used data range, default=true |
| includeFormulas | Boolean | Whether to include the formula when saving, default=true. |
| includeStyles | Boolean | Whether to include the style when saving, default=true. |
| includeUnusedNames | Boolean | Whether to include the unused custom name when saving, default=true. |
|saveAsView|Boolean|Whether to apply the format string to exporting value when saving, default=false.|
The following parameters can be used in the callback method:
| Parameter | Type | Description | |
|---|---|---|---|
| param1 | text | The name of the 4D View Pro object | |
| param2 | 4D.blob | The exported blob | |
| param3 | object | A reference to the command's paramObj parameter | |
| param4 | object | An object returned by the method with a status message | |
| .success | boolean | True if export with success, False otherwise. | |
| .errorCode | integer | Error code. | |
| .errorMessage | text | Error message. |
Example
The command VP EXPORT TO BLOB is asynchronous. You must create a callback method (named VPBlobCallback in our example) to use the export results.
//Export the VP document
VP EXPORT TO BLOB("ViewProArea"; {formula: Formula(VPBlobCallback)})
//VPBlobCallback method
#DECLARE($area : Text; $data : 4D.Blob; $parameters : Object; $status : Object)
var $myEntity : cs.myTableEntity
If ($status.success)
// Save the document in a table
$myEntity:=ds.myTable.new()
$myEntity.blob:=$data
$myEntity.save()
End if