Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

HTMLAddHead Function

Overview

The HTMLAddHead function adds in the heading code to an HTML Writer Object. If style sheet or other header information has been added to the object, it is added to the output buffer at this time.

Syntax/Parameters

Syntax

int = HTMLAddHead ( handle hObject, [string title, string font, string size] );

Parameters

hObject

A handle to an HTML Writer Object.

title

An optional string specifying a title for the document. This string is processed to become PCDATA. If omitted, the title is not added.

font

An optional string specifying a default font name for the document. This name is applied to the BODY tag.

size

An optional string specifying a default font size for the document. This name is applied to the BODY tag. While the size is specified as a string, it must be a valid CSS size construct such as ‘12pt’ or ‘10px’.

Return Value

Returns and integer as ERROR_NONE (0) or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

Well formed HTML should contain a header and a footer which encapsulates the body of the document.

<HTML>

<HEAD>

<TITLE>title</TITLE>

</HEAD>

<BODY>

HTMLAddHead should be called after any header items are added.

HTML writer objects can be used in segment mode where a head and foot are not added to the object but rather added when combined with other segments.

Related Functions

Platform Support

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

Legato IDE, Legato Basic