Object-Oriented Interface

rptdesigner

 

The rptdesigner object is a data member of the pvxreport object interface, delegated to store and save Report Designer options.

rptdesigner Properties

The following table lists the properties of the rptdesigner object:

Property

Description

AutoDisplayHTML

Boolean value (0/1). When On, the Report Designer will automatically display any reports generated in HTML format with the default browser. Default is 0.

AutoDisplayPDF

Boolean value (0/1). When On, the Report Designer will automatically display any reports generated in PDF format with the default PDF reader. Default is 0.

ColumnWidth

Default column width in inches or cm, depending on Metric setting. If set to 0, the Designer default will be ½ inch or 1 cm.

Font$

The default font to use for new reports. Default is Arial,-15.

Metric

Boolean value (0/1). When On, the ruler on the Designer display will use metric (centimeter) units. Default is inches.

NumericFormatMask$

The default numeric format mask to use for group functions. Default is "###,###,##0.00-".

RowHeight

Default row height in inches or cm, depending on Metric setting. If set to 0, the Designer will use a calculated value based on the size of the default font set for the current report.

SuppressPostReportLogic

Set to 1 to suppress the execution of Post Report Logic that has been defined for the report while testing via the Preview or Print buttons on the Report Designer tool bar.

(The SuppressPostReportLogic property was added in PxPlus 2022.)

TestMode

Boolean value (0/1). When On, the Designer will generate a report in test mode. Test mode restricts the number of records processed when a report is generated. A processed record is one that is included in the report, i.e. it has not been rejected by the filtering process. Default is 0.

TestRecords

The maximum number of records to be processed when a report is generated in test mode. If set to 0 (Default), the entire data source is processed.

SaveOption

Boolean value (0/1). When On, the above option values will be saved to the pvxreport.ini file. Default is 0.

rptdesigner Methods

The following table lists the methods of the rptdesigner object:

Method

Description

AddLibrary(LibName$ [,Sep$]) 

Adds a library or a Sep$ -separated list of libraries specified in LibName$. If Sep$ is not specified, then a comma is assumed.

The maximum number of default libraries is 99. Returns 1 if successful; 0 if not.

ClearLibraries( )

Clears all default libraries. Returns 1.

GetLibrary$(idx)

Returns the name of the library specified by the index idx.

GetLibraryList$([Sep$])

Returns a Sep$ -separated list of the default libraries. If Sep$ is not specified, a comma is used as the separator.

LibraryCount( )

Returns the number of default libraries.

LoadOptions( )

(Windows Only)

Loads the option values from the client or local pvxreport.ini file.

RemoveLibrary(LibName$)

Removes the library specified in LibName$ from the list of defaults. Indexes of subsequent libraries are adjusted.

SaveOptions( )

(Windows Only)

Saves the option values in the client or local pvxreport.ini file.