Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

HTMLSetCellStyle Function

Overview

The HTMLSetCellStyle function augments any default styling for the next series of table cells within an unmanaged table or applies the style to the current cell for a managed table.

Syntax/Parameters

Syntax

int = HTMLSetCellStyle ( handle hObject, [string style | string style[] );

Parameters

hObject

A handle to an HTML Writer Object.

style

An optional parameter as a string or string array. If omitted, all augmenting styles are cleared. If the value is a simple string, it must be in CSS format similar to an inline style for HTML. In array format, the string is specified in parameter name-value format where the key name for the array item is the CSS property name. Shorthand CSS nomenclature is not allowed.

Return Value

An int as ERROR_NONE (0) or a formatted error code. If an error occurs that is related to the syntax of the parameters, all the augment style parameters will be cleared. Use the GetLastErrorMessage function to determine if the error is related to a specific property. If so, the GetLastError function will return the error code with the item number in the lower bits.

Remarks

Cell style operates in managed or unmanaged mode. When in managed mode, the style is applied to the current cell as defined by the HTMLBeginCell function. The style is discarded when the cell is completed. In unmanaged mode, the style set is used for each call to the HTMLCellOpen function.

In unmanaged mode, the HTMLSetCellStyle function adds to the existing block style parameters. To start with a clean slate, perform a clear prior to adding parameters. For example:

HTMLSetCellStyle(hHTML);

HTMLSetCellStyle(hHTML, "font-family: Times New Roman, Times, Serif");

Note that the style information is additive over and above the normal HTML and CSS style model. That is, if default styles have been set for a particular type of block, this function allows that information to be augmented or overwritten. It does not allow the subtraction of styles.

Related Functions

Platform Support

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

Legato IDE, Legato Basic