Programming Interface

You can find a description of all options used in the HTML export module in this chapter. These options can be modified/read using the methods LlXSetParameter(..."HTML"...) and LlXGet­Parameter(..."HTML"...).

Resolution: Defines the resolution in dpi for the transformation of the coordinates and the generation of pictures. Default: 96 dpi screen resolution.

Picture.JPEGQuality: Specifies the quality and the corresponding compression factor of the generated JPEG graphic. The value lies between 0 and 100, with 100 representing the highest quality (and therefore the least compression). Takes effect only when the source graphic is not the JPEG format, as encoding of JPEG to JPEG would result in a quality loss. Default: 75

Picture.BitsPerPixel: Defines the color depth of the generated picture. Please note that the picture files will quickly get very large with higher color depths.

Value

Meaning

1

Black & White

24

24bit True Color

Default

24

 

Verbosity.Rectangle: Configures how rectangle objects should be exported.

Value

Meaning

0

Ignore object

1

Object as JPEG (and also as a complete rectangle for objects with colored background).

Default

1

 

Verbosity.Barcode: Configures how barcode objects should be exported.

Value

Meaning

0

Ignore object

1

Object as JPEG

Default

1

 

Verbosity.Drawing: Configures how picture objects should be exported.

Value

Meaning

0

Ignore object

1

Object as JPEG

Default

1

 

Verbosity.Ellipse: Configures how ellipse objects should be exported.

Value

Meaning

0

Ignore object

1

Object as JPEG

Default

1

 

Verbosity.Line: Configures how line objects should be exported.

Value

Meaning

0

Ignore object

1

Object as JPEG

Default

1

 

Verbosity.Text: Configures how text objects should be exported.

Value

Meaning

0

Ignore object

1

Object as text object

2

Object as JPEG

Default

1

 

Verbosity.Text.Frames: Configures how text object frames should be exported.

Value

Meaning

0

Single frames for top, bottom, left, right (uses CSS)

1

Complete frame as box

Default

0

 

Verbosity.RTF: Configures how RTF objects should be exported.

Value

Meaning

0

Ignore object

1

As formatted RTF text (parsed and converted to HTML)

2

As unformatted text (uses the default font specified in the project file)

3

Object as JPEG

Default

1

 

Verbosity.RTF.Frames: Configures how RTF object frames should be exported.

Value

Meaning

0

Single frames for top, bottom, left, right (uses CSS)

1

Complete frame as box

Default

0

 

Verbosity.Table: Configures how table objects should be exported.

Value

Meaning

0

Ignore object

1

As a table object

Default

1

 

Verbosity.Table.Cell: Configures how table cells should be exported.

Value

Meaning

0

Ignore cell

1

As a cell object using the verbosity settings of the object types specified in the cell.

2

Cells as JPEG

Default

1

 

Verbosity.Table.Frames: Configures how table frames should be exported.

Value

Meaning

0

Ignore table frame

1

Only horizontal lines of table frames

2

The whole table line including all frames

3

Cell-specific frames (uses CSS)

Default

3

 

Verbosity.LLXObject: Configures how LLX objects (e.g. chart object) should be exported.

Value

Meaning

0

Ignore object

1

Object as JPEG

Default

1

 

Verbosity.LLXObject.HTMLObj: Configures how the HTML object should be exported.

Value

Meaning

0

Ignore object

1

Object as JPEG

2

Object as embedded HTML. Only the HTML text between the <BODY> and </BODY> tags will be exported. Please note the hint on exporting limitations.

Default

2

 

HTML.Title: Specifies the title of the generated HTML document.

Layouter.Percentaged: This option configures whether the layout should be defined in absolute values or with values expressed as percentage.

Value

Meaning

0

Layout of the X coordinates in absolute values (pixel)

1

Layout of the X coordinates with values expressed as percentage

Default

0

 

Layouter.FixedPageHeight: Configures whether all pages should be forced to have the same page height.

Value

Meaning

0

Layout can shrink on the last page (e.g. if no objects have been placed in the page footer)

1

The page height is set as configured

Default

1

 

Export.Path: Path where the exported files should be saved. If this option is empty, a file selection dialog will always be displayed.

Export.File: File name of the first HTML page. Default: "index.htm". You may also use printf format strings like "%d" in the file name (ex. "Export Page %d.htm"). In this case, the files for the pages will be named by replacing the placeholder with the correctly formatted page number. Otherwise, you will get a simple page numbering for the result files.

Export.AllInOneFile: Configures the export result format.

Value

Meaning

0

Every printed page will be exported in a single HTML file.

1

The result is a single HTML file (Export.File), containing all printed pages.

Default

1

 

Export.Quiet: Use this option to configure the possibility of exporting without user interaction.

Value

Meaning

0

Export with user interaction (dialogs)

1

No dialogs or message boxes will be displayed (only if Export.Path was specified).

Default

0

 

Export.ShowResult: Specifies whether the export result will be displayed automatically. The program that displays the result will be determined by the registered file extension.

Value

Meaning

0

Result will not be displayed automatically

1

Calls ShellExecute() with Export.File.

Default

0

 

Export.ShowResultAvailable: Enables you to hide the respective checkbox in the dialog.

Value

Meaning

0

Checkbox will be hidden

1

Checkbox will be available

Default

1