GoFiler Legato Script Reference   Legato v 1.4j Application v 5.22b

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

DataSheetGetStyleProps Function

Overview

The DataSheetGetStyleProps function returns the properties for a specific style position in the style table.

Syntax/Parameters

Syntax

string[] = DataSheetGetStyleProps ( handle hSheet, int position );

Parameters

hSheet

A handle to a Data Sheet Object.

position

A zero-based int specifying the position of the style to retrieve.

Return Value

Returns a string array containing named style properties or an empty array on error. Use the GetLastError function to retrieve error information.

Remarks

Style elements are returned as array items named as follows:

	Element Key Name		Description
	FontHandle		Current Windows font handle, if any.
	StyleName		Name of style. Not required.
	FontAscent		Font ascent in TWIPS.
	FontHeight		Font height in TWIPS.
	TextColor		Color of text in hex.
	BackgroundColor		Color of background/fill in hex.
	BorderTop		Top border, if present, as CSS parameters.
	BorderRight		Right border, if present, as CSS parameters.
	BorderBottom		Bottom border, if present, as CSS parameters.
	BorderLeft		Left border, if present, as CSS parameters.
	FontName		Font name.
	FontSize		Font size expressed in CSS measurements.
	FontStyleBits		Font style settings (bold, italic, etc.)
	AlignBits		Text align.
	TextWrap		Text wrap flag.
	FirstIndent		First indent expressed in CSS measurements. Not present if 0 or implied.
	LeftIndent		Left indent expressed in CSS measurements. Not present if 0 or implied.
	RightIndent		Right indent expressed in CSS measurements. Not present if 0 or implied.
	CallerOptions		Caller’s 32-bit optional data.

 

Note that many parameters are not added if data is not available for the specific item.

Related Functions

DataSheetGetStyleCount — Gets the total number of style sheets.

DataSheetGetStyle — Gets the style in CSS form for a specified style index.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

Page revised 2024-04-22

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 04/22/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.