  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
Overview
The DataSheetGetCellText function returns the text contained within a specified cell.
Syntax/Parameters
Syntax
string = DataSheetGetCellText ( handle hSheet, int row, int column );
string = DataSheetGetCellText ( handle hSheet, string row, string column );
string = DataSheetGetCellText ( handle hSheet, string address );
Parameters
hSheet
A handle to a Data Sheet object.
row
An int or string specifying a zero-based row or Y position for the cell.
column
An int or string specifying a zero-based column or X position for the cell.
address
A string specifying the cell position by cell address such as “A1”.
Return Value
Returns a string containing a copy of the cell’s content or an empty string if the cell does not have content or on failure. Use the GetLastError function to retrieve error information.
Remarks
Depending on the cell’s type, the text may be the result or working data. For example, a check box will return a string of ‘1’ if checked and ‘0’ or empty if unchecked. An empty string does not necessarily indicate an error since the cell may not contain text or, as in the previous example, an empty string is meaningful because of the cell’s type. Use the GetLastError function to determine if an error occurred.
The Data Sheet object stores the information as an 8-bit null terminated string, normally as UTF-8. While object does not concern itself with the content, Data Control and Data View treat the content as UTF-8.
The text of a cell can be as large as 2MB.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Page revised 2024-10-21
| Table of Contents | < < Previous | Next >> |
© 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.