GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

DataSheetEnumerateSheets Function

Overview

The DataSheetEnumerateSheets function scans an XDS (XML Data Sheet) workbook and returns all the sheets as an index table.

Syntax/Parameters

Syntax

string[][] = DataSheetEnumerateSheets ( string filename );

Parameters

filenane

A string specifying the location of an XDS file.

Return Value

Returns a string table with a row for each sheet or an empty array on failure. Use the GetLastError and GetLastErrorMessage to retrieve further information on error. The last message will contain some detail as to potential syntax errors within the XDS file.

Remarks

The return data is a two-dimensional table with a row entry for each sheet columns key names as follows

	Key Name		Description
	name		Name of the sheet (as it appears on the tab).
	description		A description of the sheet.
	comment		Any comments for the sheet.
	tip		A tool tip value for tab hover.
	ref_id		Reference ID (not accessible from Data View Properties).
	display		Display Information (not accessible from Data View Properties).
	user_data		User information (not accessible from Data View Properties).

 

The DataSheetEnumerateSheets function can be used to find a specific sheet prior to accessing the data. The index position can then be used to open a specific sheet.

Related Functions

DataSheetOpen — Creates and Data Sheet Object and loads the data from the file specified by filename.

DataSheetToTable — Exports an existing sheet by handle or a sheet as specified by a file to a data string table.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.