Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ElevenSGML Functions (continued)

HTMLTableToText Function

Overview

The HTMLTableToText function exports all of a Table Object to simple text or HTML.

Syntax/Parameters

Syntax

string = HTMLTableToText ( handle hTable, [dword flags] );

Parameters

hTable

A handle to an HTML Table Map Object.

flags

An optional dword specifying options for writing. If omitted, the value is MAP_EXPORT_NO_TABLE.

Return Value

Returns a string containing the table content as text or simple HTML or an empty string on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The flags specify bitwise parameters as follows:

  Define   Ordinal/
Bitwise
  Comment
  Text      
    MAP_EXPORT_NO_TABLE   0x00000000   Write only the table text.
    MAP_EXPORT_REMOVE_ALL_CODE   0x00000004   Write only the table text.
    MAP_EXPORT_MAKE_TABBED   0x00000005   Writes text with tabs between cells.
    MAP_EXPORT_MAKE_PRINT_IMAGE   0x00000006   Writes and attempts to format spacing and alignment as text.
  HTML        
    MAP_EXPORT_SINGLE_BLOCK   0x00000001   Consolidates all into a single HTML block.
    MAP_EXPORT_ROWS_TO_BLOCKS   0x00000002   Consolidates each row into an HTML block.
    MAP_EXPORT_CELLS_TO_BLOCKS   0x00000003   Each cell becomes a block.
  Options        
    MAP_EXPORT_ADD_NEW_LINES   0x00010000   OR to add new line characters for each line.

 

Related Functions

Platform Support

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

Legato IDE, Legato Basic