Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter ElevenSGML Functions (continued)

HTMLSetBlockStyle Function

Overview

The HTMLSetBlockStyle function augments any default styling for the next series of blocks (unmanaged paragraphs).

Syntax/Parameters

Syntax

int = HTMLSetBlockStyle ( 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.

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 zero-based item number in the lower bits.

Remarks

The HTMLSetBlockStyle function adds to the existing block style parameters. To start with a clean slate, perform a clear prior to adding parameters. For example:

HTMLSetBlockStyle(hHTML);

HTMLSetBlockStyle(hHTML, "text-align: center");

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