HTMLTableToString Function

GoFiler Legato Script Reference

Legato v 1.5b

Application v 5.24b

Table of Contents	< < Previous	Next >>

Chapter Eleven — SGML Functions (continued)

HTMLTableToString Function

Overview

The HTMLTableToString function exports all or part of the contents of a table map to a string as HTML.

Syntax/Parameters

Syntax

string = HTMLTableToString ( handle hTable, [int flags],
[int start_row, int start_column],
[int end_row, int end_column] );

Parameters

hTable

A handle to an HTML Table Map Object.

flags

An optional int specifying flags to set options for writing. If omitted, the value is 0. This value must be set to set a range of cells.

start_row start_column

An optional set of zero-based int values specifying the upper left bounding cell area to write. If omitted, the values are 0 and 0 respectively.

end_row end_column

An optional set of zero-based int values specifying the lower right bounding cell area to write. If omitted, the values are 0x7FFFFFFF and 0x7FFFFFFF respectively.

Return Value

Returns a string containing the coded table 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		Bitwise	Comment
Map Write to Pool
	MAP_WRITE_ALLOW_CELL_OVERRIDE	0x00000001	Use Cell Flags if Available
Character
	MAP_WRITE_PROCESS_UTF	0x00000002	Read UTF-8 and Process
Coding
	MAP_WRITE_NO_PAD	0x00000004	Do Not Pad Cells
	MAP_WRITE_NO_WRAP	0x00000008	Do Not Wrap Cell Content
	MAP_WRITE_CODE_GUTTERS_WITH_DATA	0x00000010	Put Gutters on Same Line
	MAP_WRITE_NEW_LINES	0x00000020	New Lines (0x0D 0x0A)
General Options/Attributes
	MAP_WRITE_NO_IDS	0x00000200	Remove Any IDs
	MAP_WRITE_NO_CLASS	0x00000400	Remove Any CLASS References
	MAP_WRITE_NO_HEIGHT	0x00000800	Remove Any HEIGHT Specifications
	MAP_WRITE_NO_PADDING	0x00001000	Remove Any Padding
	MAP_WRITE_NO_PROPERTIES	0x00002000	Rip Out Everything
	MAP_WRITE_TRIM_MATRIX	0x00004000	Extra Columns, Rows Removed
	MAP_WRITE_STRIP_STYLE	0x00008000	Strip All Style/Font Stuff
Cells (can be overridden)
	MAP_WRITE_CELL_OVERRIDE_MASK	0xFFFF0000	Flags Specific of Cells
	MAP_WRITE_CELL_NBSP	0x00010000	Replace with Non-Breaking Space
	MAP_WRITE_CELL_EMPTY_NBSP	0x00020000	Fill Empty Cells with a Non-Breaking Space
	MAP_WRITE_CELL_CONTENTS	0x00040000	Write the Content of Cell
	MAP_WRITE_CELL_NO_TABLES	0x00080000	Do Not Write Table Items
	MAP_WRITE_CELL_NO_BLOCKS	0x00100000	Do Not Write Blocks
	MAP_WRITE_CELL_NO_STYLE	0x00200000	Do Not Write Inline Styles
	MAP_WRITE_CELL_NO_LEADERS	0x00400000	Remove Any Leader Data
	MAP_WRITE_CELL_NO_PAGE_BREAKS	0x00800000	Remove Page Break Data
	MAP_WRITE_CELL_DISPLAY_NONE	0x01000000	Pass Through Display: None
	MAP_WRITE_CELL_NO_LEADING_NBSP	0x02000000	Trim Off Leading nbsp
	MAP_WRITE_CELL_RIGHT_PAD_NUMBER	0x04000000	Right Pad Number for () Spacing
	MAP_WRITE_CELL_STRIP_HDR_ACCESS	0x08000000	Strip Out Header Reference Access

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Table of Contents	< < Previous	Next >>

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.