  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
HTMLStyleSetProperties Function
Overview
The HTMLStyleSetProperties function sets the style properties for a selected area of the buffer for the the entire buffer.
Syntax/Parameters
Syntax
int = HTMLStyleSetProperties ( handle hStyle, string properties,
[int
start], [int end] );
Parameters
hStyle
A handle to an HTML Style Object.
properties
A string array containing the style properties to apply to the text within the object.
start
An optional int specifying the zero-based position to begin applying the style. If omitted, the default value is 0.
end
An optional int specifying the zero-based position to end applying the style. If omitted, the default value is the end of the text within the buffer.
Return Value
An int as ERROR_NONE or a formatted error code on error. Use the GetLastError function to retrieve a formatted error code.
Remarks
The properties parameter contains the CSS properties to adjust in the form of a keyed array. CSS property names are used as the key name values as list below:
| font-family | Font name. | |||
| font-size | Size as specified. | |||
| font-weight | Weight, including the <b> tag. | |||
| font-stretch | Stretch keyword. | |||
| font-style | Style as normal or italic, including the <i> tag. | |||
| font-variant | Small caps. | |||
| text-decoration-line | Type of line on text, including underline including <u> tag. | |||
| text-decoration-color | Line color. | |||
| text-decoration-style | Line style. Conflicts with text-underline-style. | |||
| text-transform | Capital, lower and upper case. | |||
| text-underline-style | Underline style (note, as part of CSS, this conflicts with text-decoration-style but included for compatibility). | |||
| color | Text color. | |||
| letter-spacing | Letter spacing. | |||
| line-height | Line height. | |||
| vertical-align | Vertical align. | |||
| word-spacing | Word spacing. | |||
| background-color | Background color. |
The element values can be one of three types: (i) empty or “(default)”, which will reset or remove the style property; (ii) “(mixed)” or not present (no defined element), which will leave the property unaltered; or (iii) a legal CSS property value.
String data types, such as the font name or colors, are not checked for validity except for theoverall string length.
The start and end parameters can be used to adjust a specific area within the text buffer. Note that the specified positions are within the text area, any HTML style elements are removed from the text as the data is loaded into the Style Object.
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.