VP EXPORT DOCUMENT

História

Release	Mudanças
20 R2	Suporte de documentos .sjs

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

Parâmetro	Tipo		Descrição
vpAreaName	Text	->	Nome de objeto formulário área 4D View Pro
filePath	Text	->	Caminho do documento
paramObj	Object	->	Opções de exportação

Descrição

O comando VP EXPORT DOCUMENT exporta o objeto do 4D View Pro anexado à área vpAreaName do 4D View Pro para um documento em disco, de acordo com os parâmetros filePath e paramObj.

Em vpAreaName, passe o nome da área 4D View Pro. Se passar um nome que não existe, é devolvido um erro.

Em filePath, passe o caminho de destino e o nome do documento a ser importado. Se você não especificar um caminho, o documento será salvo no mesmo nível da pasta Project.

Você pode especificar o formato do arquivo exportado incluindo uma extensão após o nome do documento:

• 4D View Pro (".4vp")
• Microsoft Excel (".xlsx")
• PDF (".pdf")
• CSV (".txt", ou ".csv")
• Documento SpreadJS (".sjs")

Se a extensão não for incluída, mas o formato for especificado em paramObj, o arquivo exportado terá a extensão que corresponde ao formato, exceto para o formato CSV (nenhuma extensão é adicionada nesse caso).

O parâmetro opcional paramObj permite que você defina várias propriedades para o objeto exportado do 4D View Pro, bem como inicie um método de retorno de chamada quando a exportação for concluída.

Propriedade		Tipo	Descrição
format		text	(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.
senha		text	Somente Microsoft Excel (opcional) - Senha usada para proteger o documento do MS Excel
formula		4D. Function	Método de retorno de chamada a ser lançado quando a exportação estiver concluída. O uso de um método de retorno de chamada é necessário quando a exportação é assíncrona (que é o caso dos formatos PDF e Excel) se você precisar que algum código seja executado após a exportação. The callback method must be passed with the Formula command. See Passing a callback method (formula).
valuesOnly		boolean	Especifica que somente os valores das fórmulas (se houver) serão exportados.
includeFormatInfo		boolean	Verdadeiro para incluir informações de formatação; caso contrário, falso (o padrão é verdadeiro). As informações de formatação são úteis em alguns casos, por exemplo, para exportação para SVG. On the other hand, setting this property to false allows reducing export time.
includeBindingSource		boolean	4DVP e Microsoft Excel apenas. True (padrão) para exportar os valores do contexto de dados atual como valores de célula no documento exportado (os contextos de dados em si não são exportados). Caso contrário, false. Cell binding sempre é exportada. For data context and cell binding management, see VP SET DATA CONTEXT and VP SET BINDING PATH.
sheetIndex		number	Somente PDF (opcional) - Índice da planilha a ser exportada (a partir de 0). -2=all visible sheets (default), -1=current sheet only
pdfOptions		object	PDF only (optional) - Options for pdf
	creator	text	nome do aplicativo que criou o documento original a partir do qual ele foi convertido.
	title	text	título do documento.
	autor	text	nome da pessoa que criou o documento.
	keywords	text	palavras-chave associadas ao documento.
	subject	text	assunto do documento.
csvOptions		object	Apenas CSV (opcional) - Opções para exportação csv
	range	object	Objeto intervalo de células
	rowDelimiter	text	Delimitador de linha. Default: "\r\n"
	columnDelimiter	text	Delimitador de coluna. 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	Se deve incluir os dados extras de cálculo. 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.
	senha	text	Password to set to open the workbook.
\<customProperty>		any	Qualquer propriedade personalizada que estará disponível por meio do parâmetro $3 no método de retorno de chamada.

Notas sobre o formato Excel:

• Ao exportar um documento do 4D View Pro para um arquivo no formato Microsoft Excel, algumas configurações podem ser perdidas. Por exemplo, os métodos e fórmulas 4D não são suportados pelo Excel. You can verify other settings with this list from SpreadJS.
• Exporting in this format is run asynchronously, use the formula property of the paramObj for code to be executed after the export.
• 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.

Notas sobre o formato PDF:

• Ao exportar um documento do 4D View Pro em PDF, as fontes usadas no documento são automaticamente incorporadas ao arquivo PDF. Somente fontes OpenType (arquivos .OTF ou .TTF) com um mapa Unicode podem ser incorporadas. Se não for encontrado nenhum arquivo de fonte válido para uma fonte, será usada uma fonte padrão.
• Exporting in this format is run asynchronously, use the formula property of the paramObj for code to be executed after the export.

Notas sobre o formato CSV:

• Ao exportar um documento do 4D View Pro para CSV, algumas configurações podem ser perdidas, pois somente o texto e os valores são salvos.
• Todos os valores são guardados como cadeias de caracteres entre aspas duplas. For more information on delimiter-separated values, see this article on Wikipedia.
• Exporting in this format is run asynchronously, use the formula property of the paramObj for code to be executed after the export.

Notas sobre o formato de arquivo SpreadJS:

• Os arquivos SpreadJS são arquivos compactados.
• Exporting in this format is run asynchronously, use the formula property of the paramObj for code to be executed after the export.

Once the export operation is finished, VP EXPORT DOCUMENT automatically triggers the execution of the method set in the formula property of the paramObj, if used.

Passagem de um método de retorno de chamada (fórmula)

When including the optional paramObj parameter, the command allows you to use the Formula command to call a 4D method which will be executed once the export has completed. O método de retorno de chamada receberá os seguintes valores em parâmetros locais:

Parâmetro		Tipo	Descrição
param1		text	O nome do objeto de área 4D View Pro
param2		text	O caminho do ficheiro do objeto 4D View Pro exportado
param3		object	Uma referência ao paramObj do comando
param4		object	Um objeto devolvido pelo método com uma mensagem de estado
	.success	boolean	True se a exportação for bem sucedida, False caso contrário.
	.errorCode	integer	Código de erro.
	.errorMessage	text	Mensagem de erro.

Exemplo 1

Pretende exportar o conteúdo da área "VPArea" para um documento 4D View Pro no disco:

var $docPath: Text

$docPath:="C:\\Bases\\ViewProDocs\\MyExport.4VP" VP EXPORT DOCUMENT("VPArea";$docPath)
//MyExport.4VP is saved on your disk

Exemplo 2

Pretende exportar a folha atual em 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)

Exemplo 3

Você deseja exportar um documento do 4D View Pro no formato ".xlsx" e chamar um método que iniciará o Microsoft Excel com o documento aberto após a conclusão da exportação:

 var $params:={}
 $params.formula:=Formula(AfterExport)
 $excelOptions:={includeStyles:false;includeFormulas:true}
 $params.excelOptions:=$excelOptions
 VP EXPORT DOCUMENT("ViewProArea";"c:\\tmp\\convertedfile.xlsx";$params)

Método 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

Exemplo

You want to export the current sheet to a .txt file with pipe-separated values:

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))

Aqui está o resultado:

Veja também

VP Convert to picture
VP Export to object
VP IMPORT DOCUMENT
VP Print
4D View Pro: Excel import/export update (blog post)