Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EightData 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

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-10-21