Saltar al contenido principal
Versión: 20 R6 BETA

VP EXPORT DOCUMENT

Historia
LanzamientoModificaciones
20 R2Soporte de documentos .sjs

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

ParámetrosTipoDescripción
vpAreaNameText->Nombre de objeto formulario área 4D View Pro
filePathText->Ruta de acceso del documento
paramObjObject->Opciones de exportación

Descripción

El comando VP EXPORT DOCUMENT exporta el objeto de 4D View Pro adjunto al área 4D View Pro vpAreaName a un documento en disco según los parámetros filePath y paramObj.

En vpAreaName, pase el nombre del área 4D View Pro. Si pasa un nombre que no existe, se devuelve un error.

En filePath, pase la ruta de destino y el nombre del documento a exportar. Si no especifica una ruta, el documento se guardará en el mismo nivel que la carpeta Project.

Puede especificar el formato del archivo exportado incluyendo una extensión después del nombre del documento:

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

Si no se incluye la extensión, pero se especifica el formato en paramObj, el archivo exportado tendrá la extensión que corresponda al formato, excepto para el formato CSV (en este caso no se añade ninguna extensión).

El parámetro opcional paramObj le permite definir múltiples propiedades para el objeto 4D View Pro exportado y lanzar un método de retrollamada cuando la exportación haya finalizado.

PropiedadTipoDescripción
formattext(opcional) Cuando está presente, designa el formato del archivo exportado: ".4vp" (por defecto), ".csv", ".xlsx", ".pdf" o ".sjs". Puede utilizar las siguientes constantes
  • :vk 4D View Pro format``vk</li><li> csv format``vk</li><li> MS Excel format``vk</li><li> pdf format``vk</li><li> sjs format
  • 4D añade la extensión adecuada al nombre del archivo si es necesario. Si el formato especificado no corresponde con la extensión en filePath, se añadirá al final de filePath. Si no se especifica un formato y no se da ninguna extensión en filePath, se utiliza el formato de archivo por defecto.
    contraseñatextSólo Microsoft Excel (opcional) - Contraseña utilizada para proteger el documento MS Excel
    formula4D.FunctionMétodo de retrollamada que se lanzará cuando la exportación haya finalizado. La utilización de un método de retrollamada es necesaria cuando la exportación es asíncrona (que es el caso de los formatos PDF y Excel) si necesita que se ejecute algún código después de la exportación. El método retrollamada debe pasarse con el comando Formula. Ver Pasar un método de retrollamada (fórmula).
    valuesOnlybooleanEspecifica que sólo los valores de las fórmulas (si las hay) serán exportados.
    includeFormatInfobooleanTrue para incluir información de formato, false en caso contrario (por defecto es True). La información de formato es útil en algunos casos, por ejemplo, para una exportación a SVG. Por otro lado, poner esta propiedad en false permite reducir el tiempo de exportación.
    includeBindingSourcebooleanSólo 4DVP y Microsoft Excel. True (por defecto) para exportar los valores del contexto de datos actual como valores de celda en el documento exportado (los contextos de datos en sí no se exportan). False en caso contrario. El enlace de la celda siempre se exporta. Para la gestión de los contextos de datos y de las fusiones de celdas, ver VP SET DATA CONTEXT y VP SET BINDING PATH.
    sheetIndexnumberPDF únicamente (opcional) - Índice de la hoja a exportar (empezando por 0). -2=todas las hojas visibles (por defecto), -1=sólo la hoja actual
    pdfOptionsobjectSólo PDF (opcional) - Opciones para la exportación de pdf

    PropiedadTipoDescripción
    creatortextnombre de la aplicación que creó el documento original a partir del cual se convirtió.
    titletexttítulo del documento.
    authortextnombre de la persona que ha creado el documento.
    keywordstextpalabras clave asociadas al documento.
    subjecttextasunto del documento.

    csvOptionsobjectSólo CSV (opcional) - Opciones para la exportación csv

    PropiedadTipoDescripción
    rangeobjectObjeto rango de celdas
    rowDelimitertextDelimitador de fila. Por defecto: "\r\n"
    columnDelimitertextDelimitador de columna. Por defecto: ","

    sjsOptionsobjectSJS solo (opcional) - Opciones para exportar a sjs

    PropiedadTipoDescripción
    includeAutoMergedCellsbooleansi se deben incluir las celdas fusionadas automáticamente, el valor predeterminado es false.
    includeBindingSourcebooleansi se debe incluir la fuente de datos, el valor predeterminado es true.
    includeCalcModelCachebooleansi se debe incluir los datos adicionales de cálculo. Can be faster when open the file with those data, default is false.
    includeEmptyRegionCellsbooleanwhether to include any empty cells (cells with no data or only style) outside the used data range, default is true.
    includeFormulasbooleanwhether to include the formulas, default is true.
    includeStylesbooleanwhether to include the style, default is true.
    includeUnusedNamesbooleanwhether to include the unused custom names, default is true.
    saveAsViewbooleanwhether to apply the format string to exporting values, default is false.

    \<customProperty>anyToda propiedad personalizada que estará disponible a través del parámetro $3 en el método de retrollamada.

    Notas sobre el formato Excel:

    • Al exportar un documento 4D View Pro a un archivo con formato Microsoft Excel, pueden perderse algunos parámetros. Por ejemplo, los métodos y fórmulas 4D no son soportados por Excel. Puede verificar otras configuraciones con esta lista de SpreadJS.
    • La exportación en este formato se ejecuta de forma asíncrona, utilice la propiedad formula del paramObj para el código a ejecutar después de la exportación.

    Notas sobre el formato PDF:

    • Al exportar un documento 4D View Pro en PDF, las fuentes utilizadas en el documento se integran automáticamente en el archivo PDF. Sólo se pueden integrar las fuentes OpenType (archivos .OTF o .TTF) que tengan un tabla Unicode. Si no se encuentra un archivo de fuentes válido para una fuente, se utiliza una fuente por defecto.
    • La exportación en este formato se ejecuta de forma asíncrona, utilice la propiedad formula del paramObj para el código a ejecutar después de la exportación.

    Notas sobre el formato CSV:

    • Al exportar un documento 4D View Pro al formato CSV, es posible que se pierdan algunos parámetros, ya que sólo se guardan el texto y los valores.
    • Todos los valores se guardan como cadenas entre comillas. Para más información sobre valores separados por delimitadores, ver este artículo en Wikipedia.
    • La exportación en este formato se ejecuta de forma asíncrona, utilice la propiedad formula del paramObj para el código a ejecutar después de la exportación.

    Notas sobre el formato de archivo SpreadJS:

    • Los archivos SpreadJS son archivos comprimidos.
    • La exportación en este formato se ejecuta de forma asíncrona, utilice la propiedad formula del paramObj para el código a ejecutar después de la exportación.

    Una vez finalizada la operación de exportación, VP EXPORT DOCUMENT activa automáticamente la ejecución del método definido en la propiedad formula del paramObj, si se usa.

    Pasar un método retrollamada (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. El método de retrollamada recibirá los siguientes valores en parámetros locales:

    ParámetrosTipoDescripción
    param1textEl nombre del objeto de área 4D View Pro
    param2textRuta de acceso del objeto 4D View Pro exportado
    param3objectUna referencia al paramObj del comando
    param4objectUn objeto devuelto por el método con un mensaje de estado
    .successbooleanTrue si exporta con éxito, de lo contrario False.
    .errorCodeintegerCódigo de error.
    .errorMessagetextMensaje de error.

    Ejemplo 1

    Quiere exportar el contenido del área "VPArea" a un documento 4D View Pro en el disco:

    var $docPath: Text

    $docPath:="C:\\Bases\\ViewProDocs\\MyExport.4VP"
    VP EXPORT DOCUMENT("VPArea";$docPath)
    //MyExport.4VP se guarda en su disco

    Ejemplo 2

    Quiere exportar la hoja actual en 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)

    Ejemplo 3

    Desea exportar un documento 4D View Pro en formato ".xlsx" y llamar a un método que inicie Microsoft Excel con el documento abierto una vez completada la exportación:

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

    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

    Ejemplo 4

    Quiere exportar la hoja actual a un archivo .txt con valores separados por "|":

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

    Aquí está el resultado:

    example-export-csv

    Ver también

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