Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EightData Functions (continued)

DataSheetExportRegion Function

Overview

The DataSheetExportRegion function exports an area of a sheet to HTML, CSV or XML.

Syntax/Parameters

Syntax

string = DataSheetExportRegion ( handle hSheet, [int start_row], [int start_col],
                                            [int end_row], [int end_col], [int format] );

Parameters

hSheet

A handle to a Data Sheet Object.

start_row   start_col   end_row   end_col

Optional int values specifying the zero-based area to export. Start points are inclusive, end points are exclusive. If not provided, the values are zero. If the ending row or ending column are zero, they are set to the last row or column, respectively.

format

An optional int specifying the format to write. If not specified, the default is HTML (FT_HTML).

Return Value

A string containing the result or empty on failure. Use the GetLastError to retrieve a formatted error code.

Remarks

The formats supported are: FT_ANSI, FT_CSV, FT_HTML and FT_XDS_II. If the format is not known, it will default to FT_XDS_II.

The XML export does not write a schema or XML wrapper for XDS. This is done to facilitate the option of writing multiple sheets into a single output as a workbook.

See the Appendix E, XML Data Sheet Format Specification for additional information. Legacy XDS (Mark I) cannot be exported from a Data Sheet Object.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic