GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

HTMLStyleGetProperties Function

Overview

The HTMLStyleGetProperties function returns the style properties for the current buffer or part of the buffer.

Syntax/Parameters

Syntax

string[] = HTMLStyleGetProperties ( handle hStyle, [int start], [int end] );

Parameters

hStyle

A handle to an HTML Style Object.

start

An optional int specifying the zero-based position to start rendering from. If omitted, the default value is -1 (same as zero starting from the beginning).

end

An optional int specifying the zero-based position to start rendering from. If omitted, the default value is -1, indicating to return data to the end of the buffer, or if start is provided, this at the start position.

Return Value

A string array containing the style properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The function looks at each character position within the styled text and returns an aggregate of the style data. Note that the tags that lead to the text being styled are not part of the text buffer and do not count toward the position. For example, the following text is added:

The is <b>bold</b> text.

It is internally as represented as:

The is bold text.

Therefore, the start position of ‘b’ is 7.

The returned string array uses lower case versions of the CSS property names as key names.

	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.

 

If an item is not set, the element’s value is an empty string. If there are conflicting style states with the range of the buffer, the element will have the term, “(mixed)”, in the key array position.

The start and end positions must be range within the end of the text buffer (not the coded area). If only the start position is supplied, then the function will return a snapshot of that x position within the buffer.

Related Functions

HTMLStyleAddAttribute — Adds or removes one or more style attributes.

HTMLStyleAddBlock — Adds a complete block of data to a Style Object.

HTMLStyleAddItem — Adds a word or tag to a Style Object.

HTMLStyleCreate — Creates an HTML Style Object based on a source object or DTD type.

HTMLStyleGetProperties — Gets the properties for the complete or selected section of the loaded data.

HTMLStyleNormalize — Normalizes certain styles within the Style Object.

HTMLStyleRenderText — Renders the text in the Style Object data store without tags.

HTMLStyleReset — Resets the Style Object settings and content.

HTMLStyleSetProperties — Sets the style properties for all or part of the text within the Style Object.

HTMLStyleSetSelectArea

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 10/21/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.