Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ElevenSGML Functions (continued)

OutlineGetItemHTML Function

Overview

The OutlineGetItemHTML function returns the HTML text associated with a specific outline position. The data is treated as HTML and all extra word spaces are converted to single plan spacing.

Syntax/Parameters

Syntax

string = OutlineGetItemHTML ( handle hOutline, int position );

Parameters

hOutline

A handle to an HTML Outline Object.

position

An int specifying the zero-based position for a mapped outline entry.

Return Value

A string containing the HTML for the outlined item. On error, the string will be empty. Use the GetLastError function to retrieve a formatted error code.

Remarks

The returned string will contain the open and closing container tags as well as any data in between. The stream is not corrected for errors and the HTML code is untouched. All white space is treated as word space and replaced with a single space. This means any code formatting is removed.

The maximum size of data that can be retrieve is 2MB. Preformatted text cannot be retrieved without losing formatting.

Related Functions

Platform Support

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

Legato IDE, Legato Basic