  |
GoFiler Legato Script Reference
Legato v 1.6j Application v 6.5c
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The HTMLElementGetString function retrieves a specified property from the HTML Element Object in the form of a string.
Syntax/Parameters
Syntax
string = HTMLElementGetString ( handle hHE, dword property | string property );
Parameters
hHE
A handle specifying the HTML Element Object.
property
A dword or string specifying an SDK defined HTML or CSS property, as token or string name. For example, CP_MARGIN_TOP token for the CSS margin-top property or just “margin-top” as a string.
Return Value
A string containing a property’s value or an empty string on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
For standard W3C defined attributes and properties, SDK defined token values can be referenced with the following standard prefixes:
HA_ — HTML attribute. for example, HA_ALIGN or HA_SIZE for “ALIGN=” or “SIZE=”
CP_ — CSS property, for example, CP_TEXT_ALIGN or CP_MARGIN_TOP for “text-align” or “margin-top”
Note for defined values, any where a dash ‘-’ is used in a name, it is replaced with an underbar ‘_’. See Appendix A — Legato SDK Standard Definitions for a complete list of definitions. For CSS properties, note that shorthand values are always converted to their constituent components, for example, “margin: 0pt” will have four properties for top, right, bottom and left. As such, specifying a shorthand property name will return as unsupported.
When using a string as a property name, adding a ‘+’ prefix will force the value to be a CSS property and to ignore the HTML attribute names.
Values can have five states: the value, mixed, default, error or unsupported. See the Section 11.7 The HTML Element Object† for additional information.
This function differs from HTMLElementGetValue by returning a string representation of the value. For attribute/propery values that are strictly strings, for example the HTML CLASS attribute, the value can only be returned as a string.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Page revised 2026-07-20
| Table of Contents | < < Previous | Next >> |
© 2012-2026 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission is prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. Novaworks, GoFiler™ and Legato™ are registered 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 the 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.