NTPSetDesignerOption

 

NTPSetDesignerOption ( <OptionID>, <OptionValue> ) -> <ErrorCode>

 

 

Description

 

This command allows the setting of the various options for the layout designer.

 

 

Declaration for Lotus Script

 

Declare Function NTPSetDesignerOption Lib "NTP.DLL" ( Byval OptionID As Long, Byval OptionValue As Long ) As Long

 

 

Parameters

 

<OptionID> (LONG)

The possible values which can be manipulated.

 

NTPOPTION_DESIGNER_SCALABLEFONTS (9000)

NTPOPTION_DESIGNER_SKETCHCOLORDEPTH (9001)

NTPOPTION_DESIGNER_CONFIRMREPORTUPDATE (9002)

NTPOPTION_DESIGNER_ONLYSAMEINTCHARS (9003)

NTPOPTION_DESIGNER_DELETEPRINTERDEF (9004)

NTPOPTION_DESIGNER_INCLUDEFONTDESCENDERS(9005)

 

<OptionValue> (LONG)

The new setting of the NotesToPaper option.

 

NTPOPTION_DESIGNER_SCALABLEFONTS

1 = the font selection windows in the layout designer will show only true type fonts. This prevents the use of fonts that may not scale correctly when printed.

0 = the font selection windows in the layout designer will show all fonts, not only true type fonts.

 

NTPOPTION_DESIGNER_SKETCHCOLORDEPTH

This option defines which color depth is to be used for the report preview, possible values are:

0 = 1 bit

1 = 4 bit

2 = 8 bit

3 = 32 bit

 

NTPOPTION_DESIGNER_CONFIRMREPORTUPDATE

If a report that was originally created by using a previous NotesToPaper version is edited, this report will automatically be converted to the new format. As this conversion cannot be undone and the report will then no longer be executable with an older NotesToPaper version, the NotesToPaper Designer will warn before converting reports. This option allows the warning dialogue to be deactivated.

1 = Ask before converting

0 = Convert without asking

 

NTPOPTION_DESIGNER_ONLYSAMEINTCHARS

The layout designer uses certain control characters within a layout file in order to be able to structure the file's contents. These are mostly unused characters within the character set, respectively the codepage. NotesToPaper will set these control characters automatically depending on the code page in use. Should you edit a report that is based on a code page different from the one your operating system is under, this may then lead to problems in the report layout. This option prevents that such a report may be edited and thus the report layout may possibly be damaged.

1 = Allow editing only for report layouts based on the same codepage

0 = Allow editing of all reports, regardless of which codepage a report is based on

 

NTPOPTION_DESIGNER_DELETEPRINTERDEF

The current printer settings are saved in a report, every time a report is edited and then saved. Should you not want these settings to be saved, activate this option. This option is used mainly if the printers currently available will not be available in the environment the report will later be executed in. In this case, it will be better to set the printer by using Lotus Script (NTPPrinterSetPrinterName) and thus deactivating the option to save the current printer with the report.

1 = Deletes the printer settings

0 = Saves the printer settings

 

NTPOPTION_DESIGNER_INCLUDEFONTDESCENDERS

The line height for text output is calculated by use of a fixed formulae, depending on the font and font size selected. There are however fonts that use unusually long font descenders and these descenders may be cut off during the output. In order to ensure, that this does not happen, the formulae for the line height calculation can be changed in order for the font descenders to be taken into consideration. In order to activate this option, this option needs to be set.

 

Note: Use this option only if you have a problem with font descenders. Activating this option generally leads to an increase in line height and may lead to a displacement of text contents respectively the line spacing.

 

0 =        The formulae for the line height calculation does not consider font descenders

1 =        The formulae for the line height calculation does consider font descenders

 

 

Return value

 

<ErrorCode> (LONG)

Number of the error encountered (0 = no error)