Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EightData Functions (continued)

DataSheetSetStyle Function

Overview

The DataSheetSetStyle function sets a style information into a sheet record as part of the style table.

Syntax/Parameters

Syntax

int = DataSheetSetStyle ( handle hSheet, int index, string style );

Parameters

hSheet

A handle to a Data Sheet object.

index

An int specifying the index of the style sheet. If the sheet does not exist, it will be added.

style

A string specifying the style in limited CSS format.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

Style information within a Data Sheet Object is held in a style table. Cells reference the style table to determine the style and other information about displaying a cell.

The CSS is limited to the following: 

  Propery   Description/Comment  
background-color  Background color. The value will be ‘transparent’ if omitted.  
 border-top
border-right
border-bottom
border-left
 Border specification in the form of color thickness style. The thickness and style follow the CSS border values.  
 color  Text color. The value will be ‘auto’ if omitted (normally black).  
 font-family  Specified font family name. The value must be a windows name and not use CSS font groupings.  
 font-size  Font size.  
 font-style  Font style. Valid value is ‘italic’. Other values are not allowed.  
 font-weight  Font weight. Valid value is ‘bold’. Other values are not allowed.  
 text-align  

Cell alignment, both horizontal and vertical. The value can be a combination of horizontal:

left’, ‘center’, ‘right’, ‘justify

and vertical:

top’, ‘middle’, ‘bottom

The default values, if not specified are ‘left’ and ‘middle’, respectively.

The value ‘wrap’† can be appended to allow the cell to wrap text.

 
 text-decoration  

Same as CSS underline with added accounting styles. Values are:

underline’, ‘double-underline’,
underline accounting’,
double-underline accounting

Only a single value is allowed.

 
 vertical-align  Value as ‘sub’, ‘super’, ‘top’, ‘middle’ or ‘bottom  

Only the specified shorthand is allowed. The style will be rejected if an unknown parameter with a value is specified. If applying a series of CSS, items that are not compliant can be cleared prior to calling to avoid errors.

Style index 0 is reserved for the default cell style.

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-10-21