  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
HTMLTableGetCellAsText Function
Overview
The HTMLTableGetCellAsText function returns the contents of a table cell as a text string. All HTML coding is removed or translated.
Syntax/Parameters
Syntax
string = HTMLTableGetCellAsText ( handle hTable, int row, int column );
string = HTMLTableGetCellAsText ( handle hTable, int index );
Parameters
hTable
A handle to an HTML Table Map Object.
row
A zero-based int specifying the row position for the cell.
column
A zero-based int specifying the column position for the cell.
index
A zero-based int as an index to the map array.
Return Value
Returns a string containing the translated contents of the cell. The string can be empty if the cell is empty or empty on failure. Use the GetLastError function to retrieve a formatted error code.
If the map index parameter is used and the operation is successful, the high word will contain the row and the low word will contain the column. Use the GetHighWord and GetLowWord functions to retrieve the components. The size of each is limited to 0x7FFF, or 32,767.
Remarks
HTMLTableGetCellAsText will not retrieve more than 2MB of text.
If the cell is not addressable, i.e., it is spanned, the return value will be an empty string.
Character entities are converted to ANSI. UNICODE characters that cannot be translated are replaced with ‘?’ characters. Note that many empty cells are filled with a non-breaking space (0xA0 or 160) which will be returned as that character. This is performed within HTML to instantiate the cell.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| 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.