|
pvxreport |
|
The pvxreport object embodies the report definition, which consists of a series of subordinate objects for filter processing, sort sequence, parameters, groups, lines and cells. Methods are available to create, update and delete these objects. See pvxreport Methods.
The pvxreport object also has methods to generate the report. See Generating a Report.
Use the NEW( ) function to create the pvxreport object:
ObjectHandle=NEW("*rpt/pvxreport")
Sub-objects are created and maintained by pvxreport methods. Many of these methods are used by the pvxreport object itself to store the report definition and generate the report.
The following table lists the properties of the pvxreport object:
|
Property |
Description |
|
BookMarkPDF |
Indicates whether bookmarks are to be generated in PDF output. 1 - On |
|
CurrentCalcs$ |
Returns current values of calculated fields. Can be parsed into the individual calculated fields using the GetCalcFieldIolist$( ) method. Example: read data from rpt'CurrentCalcs$ TO IOL=rpt'GetCalcFieldIolist$( ) Where: rpt would be the report object handle. (The CurrentCalc$ property was added in PxPlus 2022.) |
|
CurrentKey$ |
Returns the external key value for the current record. Blank if the file does not have an external key. Can be parsed into individual key fields using the SourceKeyIolist$( ) method. Example: read data from rpt'CurrentKey$ TO IOL=rpt'SourceKeyIolist$( ) Where: rpt would be the report object handle. (The CurrentKey$ property was added in PxPlus 2022.) |
|
CurrentRecord$ |
Returns the current record. Can be parsed into the individual file fields using the RecordIolist$( ) method. Example: read data from rpt'CurrentRecord$, SEP=rpt'SourceSep$( ) TO IOL=rpt'RecordIolist$( ) Where: rpt would be the report object handle. (The CurrentRecord$ property was added in PxPlus 2022.) |
|
Designer |
Object handle for the rptdesigner object that stores and saves Report Designer options and preferences. |
|
Description of the Dynamic filter condition. See Dynamic Filters. Example: InvoiceDate$ is between StartDate$ and EndDate$ Can be set on its own or in conjunction with the SetDynamicFilter( ) method. (The DynamicFilterDescription$ property was added in PxPlus 2022.) | |
|
isLibrary |
Boolean value to indicate if processing in report or library mode. |
|
LastUpdate$ |
Date/time stamp (DTE(0:"%Ys/%Mz/%Dz%Hz:%mz")) and user ID associated with the last change to the report definition. |
|
SEP-separated list of the report files created when multiple individual reports are generated. (The MultipleReportList$ property was added in PxPlus 2022.) | |
|
Flag to indicate whether multiple individual reports are to be generated based on the NewReport property setting of a group. This property is set automatically when the NewReport property of a group is altered. (The MultipleReports property was added in PxPlus 2022.) | |
|
PaginateHTML |
Indicates whether page breaks are to be inserted into HTML output when a group changes. (The rptgroup NewPage property must be set to 1.) 1 - On |
|
(Read Only) Report destination path expression. When supplied, the destination path will be evaluated by the EvaluateReportDestinationPath$(*) method to provide the path of the report output file for PDF, HTML, tab-delimited and custom output unless the output file is independently opened. The destination path is optional for single reports but is required for definitions that generate multiple reports. The destination path expression may or may not include a file extension. If omitted, a file extension will be added when the ReportDestinationPath$ property is evaluated using the EvaluateReportDestinationPath$( ) method (.pdf for PDF documents, .htm for HTML files, and .txt for tab-delimited files). If an extension is included in the expression but does not match the output destination specified for the report, the output destination can be changed to match the extension using the "R" option with the EvaluateReportDestinationPath$(PathExpr$,Option$) method. Example: "custlist" will result in a report file called custlist.pdf, custlist.htm or custlist.txt if the output destination is PDF, HTML or tab-delimited. "custlist."+%EXT$ will result in a report name based on the value of %EXT$. Destination paths for reports that generate multiple files should be designed to evaluate to a unique path name for each file, possibly using record fields or time/date stamps in the path expression. If unique names are not generated, the individual reports will be written together in a single physical file, as is the case when the output file is independently opened when generating the report. Example: "Acct_"+ACCT_NUM$ Set this property using SetReportDestinationPath$(PathExp$) after the report definition has been opened. (The ReportDestinationPath$ property was added in PxPlus 2022.) | |
|
ReportFile$ |
Report definition file. |
|
ReportName$ |
Assigned name of the report. |
|
ScaleToFit |
Boolean property indicating if the report is to be scaled to fit. 1 - On |
|
SuppressEmpty |
Indicates that output to reports that have no data available is to be suppressed. 1 - On |
|
SuppressMultipleReportList |
Set to 1 to suppress the generation of a SEP-separated list of report files created when multiple individual reports are generated. See MultipleReportList$ property. (The SuppressMultipleReportList property was added in PxPlus 2022.) |
|
UseDynamicFilters |
Boolean property indicating if the report is to accept Dynamic filters. See Dynamic Filters. (The UseDynamicFilters property was added in PxPlus 2022.) |
|
UserLogic |
Name of user logic object. See Report Writer User Interfaces. |
The following table lists the methods of the pvxreport object:
|
Method |
Description | ||||||||
|
AcceptDynamicFilters( ) |
Display the interactive interface to accept Dynamic Filters from the end user. Returns 1 if Dynamic filters are added. Note:
| ||||||||
|
AcceptParameters( ) |
Display the interactive interface to accept parameter values from the user. Returns 1. | ||||||||
|
AddAlternateCell(ObjID) |
Add an AlternateCell rptcell object to the main rptcell object specified in ObjID. Returns AlternateCell. | ||||||||
|
AddCalcField( ) |
Creates a new rptcalcfield object using the next available sequence number. One object is created for each calculated field. The sequence number can be used as the index number to identify the object when using the RemoveCalcField( ) and GetCalcField( ) methods. CalcFieldCount is incremented. Returns the object handle if successful, 0 if not. | ||||||||
|
AddCell(Grpidx,Lnidx) |
Creates a new rptcell object using the next available sequence number. Only cells with data or formatting need to have an rptcell object created for them. Grpidx - Sequence number of the section where the cell is located. Lnidx - Sequence number of the line where the cell is located. CellCount for the specified line is incremented. Returns the object handle if successful, 0 if not. | ||||||||
|
AddFilter(ObjID,Setidx) |
Creates a new rptfilter object within the rptfilterset object specified by Setidx in the given ObjID object, using the next available sequence number. If no arguments are specified, the rptfilter object is created in the first rptfilterset object of the current object. One object is created for each filter definition. The sequence number can be used as the index number to identify the object when using RemoveFilter( ) and GetFilter( ) methods. If Setidx is not specified, an rptfilter object will be added to the first rptfilterset object. FilterCount for the rptfilterset is incremented. Returns the object handle if successful, 0 if not. | ||||||||
|
AddFilterSet(ObjID) |
Creates a new rptfilterset object in the specified object ObjID (or current object if omitted), using the next available sequence number. One object is created for each filter set. The sequence number can be used as the index number to identify the object when using the RemoveFilterSet( ) and GetFilterSet( ) methods. FilterSetCount is incremented. Returns the object handle if successful, 0 if not. | ||||||||
|
AddGroup(RWobj) |
Creates a new rptgroup object using the next available sequence number. Group sequence is very important, as the sections must be added in a very specific sequence: Page header, [Group 01 header], [Group 02 header], [Group nn header], Detail Line, [Detail Line nn ] [Group nn footer], [Group 02 footer], [Group 01 footer], Report Summary, Page Footer. One group is created for each report section. The sequence number can be used as the index number to identify the object when using the RemoveGroup( ) and GetGroup( ) methods. BreakCount is incremented. Returns the object handle if successful, 0 if not. RWobj - The report writer object handle must be passed as an argument to process multiple output file reports. (The RWobj argument was added in PxPlus 2022.) | ||||||||
|
AddGroupFunction( ) |
Creates a new rptgroupfunc object using the next available sequence number. One object is created for each function definition. The sequence number can be used as the index number to identify the object when using the RemoveGroupFunction( ) and GetGroupFunction( ) methods. FunctionCount is incremented. Returns the object handle if successful, 0 if not. | ||||||||
|
AddLine(Grpidx) |
Creates a new rptline object using the next available sequence number. It is important to add the lines in the correct sequence, as this is the sequence in which the lines will be displayed in the report. Grpidx - Sequence number of the section where the report line belongs. One object is created per line. LineCount relative to the specified section is incremented. Returns the object handle if successful, 0 if not. | ||||||||
|
AddLink( ) |
Creates a new rptlink object using the next available sequence number. One object is created for each related data source. The sequence number can be used as the index number to identify the object when using the GetLink( ), SetLink( ) and RemoveLink( ) methods. LinkCount is incremented. Returns the object handle if successful, 0 if not. | ||||||||
|
AddLinks(LinkString$) |
Clears any current
rptlink objects, then adds and populates new rptlink objects based on the links defined in LinkString$. Also opens a channel to the related data source specified for each rptlink object. | ||||||||
|
AddParam( ) |
Creates a new
rptparam object using the next available sequence number. One object is created for each parameter. | ||||||||
|
AddSortItem( ) |
Creates a new
rptsort object using the next available sequence number. These objects are added in sequence, one for each segment. | ||||||||
|
AssociateLibrary(LibraryName$) |
Associates an existing Report Writer Library, specified by LibraryName$ with the report currently being edited in the Report Designer so that its parameter and calculated field definitions, as well as its layouts, can be made available to the report definition. | ||||||||
|
Returns the number of sections in the report. This includes the Page header, Detail Lines, Report Summary, Page footer, as well as the headers and footers for all control break group definitions. | |||||||||
|
BuildRecordIolist$( ) |
Builds and returns a compiled IOList of all data fields from all selected data sources (i.e. main and related data sources). | ||||||||
|
CalcFieldCount( ) |
Returns the number of defined calculated fields. | ||||||||
|
CellCount(Grpidx,Lnidx) |
Returns the number of data-bearing cells in a line. Note: | ||||||||
|
CheckFilters(Fset,R$,K$,C$) |
Evaluates the conditions in an
rptfilterset object based on record and key data. | ||||||||
|
ClearCalcFields( ) |
Removes all rptcalcfield objects. Returns 1. | ||||||||
|
ClearFilters(ObjID) |
Removes all rptfilterset objects from the specified object, or current object if ObjID is not specified. Returns 1. | ||||||||
|
ClearGroupFunctions( ) |
Removes all rptgroupfunc objects. Returns 1. Note: | ||||||||
|
ClearGroups( ) |
Removes all sections in the report (basically clears all sections, lines and cells). Returns 1. | ||||||||
|
ClearLinks( ) |
Removes all rptlink objects. Returns 1. | ||||||||
|
ClearParams( ) |
Removes all rptparam objects. Returns 1. | ||||||||
|
ClearSort( ) |
Removes all rptsort objects. Returns 1. Note: | ||||||||
|
Reset workspace and sub-objects. Returns 1. | |||||||||
|
DataSource$( ) |
Returns the name of the current source. Depending on the source type, this could be the logical table name, the simple path, a view name or the source name for a custom data source object. | ||||||||
|
DataSourceObject$( ) |
Returns the current data source class. | ||||||||
|
DisassociateLibrary(LibraryName$) |
Disassociates a Report Writer Library specified by LibraryName$ from the report currently being edited in the Report Designer. If no library name is specified, all libraries will be disassociated. | ||||||||
|
EvaluateCalcFields$( ) |
Evaluates the calculated fields and returns the values in record format, based on the IOList returned by GetCalcFieldIolist$( ). | ||||||||
|
Evaluate and return the expression in PathExpr$. If PathExpr$ is omitted or is null, the value in the ReportDestinationPath$ property is evaluated. If the resulting destination path expression does not include a file extension, then a file extension will be added if the output destination is a PDF file (.pdf), an HTML file (.htm) or a tab-delimited file (.txt). Example: "custlist" will result in a report file called custlist.pdf, custlist.htm or custlist.txt if the output destination is PDF, HTML or tab-delimited. "custlist."+%EXT$ will result in a report name based on the value of %EXT$. If an extension is included in the expression but does not match the output destination specified for the report, then the appropriate extension for PDF, HTML or tab-delimited output will be appended to the evaluated expression, or the output destination can be changed to match the extension by setting the optional Option$ to "R" (Reset). Example: f$=Objid'EvaluateReportDestinationPath$("","R") (The EvaluateReportDestinationPath$ method was added in PxPlus 2022.) | |||||||||
|
FilterCount(ObjID,Setidx) |
Returns the number of
rptfilter objects in the
rptfilterset object specified by Setidx, in the given ObjID (or current object if not specified). | ||||||||
|
FilterSetCount(ObjID) |
Returns the number of rptfilterset objects in the given ObjID object, or current object if not specified. | ||||||||
|
Wraps up the report. Returns 1 when a report is generated. | |||||||||
|
FunctionCount( ) |
Returns the number of defined group functions. | ||||||||
|
GetBackgroundColor$(n) |
Returns background colour 1 or 2, depending on n. | ||||||||
|
GetBackgroundColorOption$( ) |
Returns the background colour option. See SetBackgroundColourOption$( ). | ||||||||
|
GetBottomMargin( ) |
Returns the size of the bottom margin in 1000's of an inch. Printer default is indicated as -1. | ||||||||
|
GetCalcField(idx | Name$) |
Returns the handle for an
rptcalcfield object. | ||||||||
|
GetCalcFieldEvaluationString$( ) |
Returns a PxPlus expression comprised of the assignment pairs used to evaluate the calculated fields. | ||||||||
|
Returns a compiled IOList consisting of the calculated fields. | |||||||||
|
GetCalcFieldList$([Sep$[,Flag$]] |
Returns a list of calculated field names. (The "V" option was added in PxPlus 2022.) | ||||||||
|
GetCell(Grpidx,Lnidx,Cellidx) |
Returns the handle for an
rptcell object. | ||||||||
|
GetColumnCount( ) |
Returns the number of columns in the report. Note:
| ||||||||
|
GetColumnCount(idx) |
Returns the number of columns in the group specified by the index value idx. | ||||||||
|
GetColumnLocation(Column) |
Returns the location of the start of a column relative to the leftmost margin. The first column is at location 0. | ||||||||
|
GetColumnWidth(Column) |
Returns width of the specified column in points (72's of an inch). | ||||||||
|
GetCondition$(ObjID) |
Returns a PxPlus expression encompassing all conditions in all filter sets in the given ObjID object. | ||||||||
|
GetCondition$(ObjID,Setidx,Filteridx) |
Returns a string containing the PxPlus expression associated with a filter. | ||||||||
|
GetConditionDescription$(ObjID,[Opt$]) |
Returns a prose description of conditions. | ||||||||
|
GetData$(VarName$) |
Returns the string data contained in a variable used in a report. | ||||||||
|
GetDataFieldList$([Sep$[,Flag$]]) |
Returns a list of data file fields available in the report, including those in the main file and related files. Sep$ - (Optional) Item separator (If omitted, default separator is a comma.) Flag$ - (Optional) Set to "D" to include the description in parentheses with each field name. Set to "V" to use variable names. (Options may be combined; i.e. "DV".) (The GetDataFieldList$( ) method was added in PxPlus 2022.) | ||||||||
|
GetDestination$( ) |
Returns the output destination (i.e. the file to be opened, such as *winprt*, *viewer*, *pdf* or *.htm files, etc.) of currently set output device. | ||||||||
|
GetDestinationFile$( ) |
Returns the file to be specified in the FILE= clause of the open option for *winprt* or *pdf*. | ||||||||
|
GetDestinationOption$( ) |
Returns the output destination option (e.g. Normal, Default, Asis) of the currently-set output device. | ||||||||
|
GetDynamicFilterFields$( ) |
Returns a list of fields to be included or excluded from the list of fields available for Dynamic Filters. The list consists of a + (plus sign) followed by the variables to include or a - (minus sign) followed by the variables to exclude. The field separator may be any character and is the last character of the list. Example: A return value of: -CST_Balance,CST_Code$, … would exclude the CST_Balance and CST_Code$ variables from the list of variables available for Dynamic filters. +Country$;Region$;State$; … would mean that only the Country$, Region$ and State$ variables would be available for Dynamic filters. If a null value is returned, all fields are available. (The GetDynamicFilterFields$( ) method was added in PxPlus 2022.) | ||||||||
|
GetFilter(ObjID,Setidx,Filteridx) |
Returns the handle for an
rptfilter object. | ||||||||
|
GetFilterSet(ObjID,Setidx) |
Returns the handle for an
rptfilterset object. | ||||||||
|
GetFont$( ) |
Returns a comma-separated string denoting the default font name, its point size, and optionally, its attributes: I (italics), B (bold). | ||||||||
|
GetGroup(idx) |
Returns the handle for an
rptgroup object. | ||||||||
|
GetGroup(Type$,Level$) |
Returns the handle for an
rptgroup object. | ||||||||
|
GetGroupFunction(idx) |
Returns the handle for an
rptgroupfunc object. | ||||||||
|
GetIolist$(Grpidx,Lnidx) |
Returns the compiled IOList for a report line. | ||||||||
|
GetInputSortkey( ) |
Returns the key number to be used for the input sort or -1 if the report generator should automatically determine this. | ||||||||
|
GetInputSortkey$( ) |
Returns a string containing the key number to be used for the input sort, or null if the report generator should automatically determine this. | ||||||||
|
GetLeftMargin( ) |
Returns the size of the left margin in 1000's of an inch. Printer default is indicated as -1. | ||||||||
|
GetLibraryCalcFieldInfo(Objid,Lib$,Name$) |
Retrieves calculation field information for the field specified by Name$ in the library file Lib$, and loads it into a *rpt/rptcalcfield object whose ID is Objid. (The *rpt/rptcalcfield object must be created and destroyed by the calling program.) Returns 1 if successful, 0 if not. | ||||||||
|
GetLibraryCalcFields$(Lib$,Sep$,Opt$) |
Returns a Sep$- separated list of calculated fields in the library file specified in Lib$. If the option Opt$ contains "D", then the list of fields will include the field descriptions in brackets following the field name. | ||||||||
|
GetLibraryGroup(Name$) |
Returns the object handle of the library layout group specified by Name$. Returns 0 if the group is not found. | ||||||||
|
GetLibraryLayouts$(LibName$,Sep$) |
If a library name is specified in LibName$, then this method returns a Sep$ -separated list of layouts from that library. | ||||||||
|
GetLibraryList$([Sep$]) |
Returns a Sep$ -separated list of currently associated libraries. If Sep$ is not specified, then a comma is used to separate the libraries. | ||||||||
|
GetLibraryParameterInfo(Objid,Lib$,Name$) |
Retrieves parameter information for the parameter specified by Name$ in the library file Lib$ and loads it into a *rpt/rptparam object whose ID is Objid. (The *rpt/rptparam object must be created and destroyed by the calling program.) Returns 1 if successful, 0 if not. | ||||||||
|
GetLibraryParameters$(Lib$,Sep$,Opt$) |
Returns a Sep$ -separated list of parameter fields in the library file specified in Lib$. If the option Opt$ contains "D", then the list of fields will include the field descriptions in brackets following the field name. | ||||||||
|
GetLine(Grpidx,Lnidx) |
Returns the handle for an
rptline object. | ||||||||
|
GetLink(idx) |
Returns the handle for an
rptlink object. | ||||||||
|
GetMargins$( ) |
Returns a colon-separated string consisting of the size of the left:top:right:bottom margins. Units are in 1000's of an inch. Printer default is indicated as -1. | ||||||||
|
GetOutputChannel( ) |
Returns the channel number to the output device. | ||||||||
|
GetOutputDevice$( ) |
Returns a code representing the current output device: P - Printer | ||||||||
|
GetPageOrientation$( ) |
Returns orientation setting: P - Portrait | ||||||||
|
GetPageSetup$( ) |
Retrieve the printer setup string containing margin and orientation settings to be used with an OPEN directive to an output device (*winprt*, *pdf*, *viewer*). When used, must include printer option string (i.e. Normal; Asis; etc.) prepended to it. RptDef$ - Name of the report definition file from which to get the setup string. If no file name is given, returns the setup string of the currently open report. Example: OPEN(1,ERR=*END)"*winprt*;OPT="Normal;File=test.prn;"+rpt'GetPageSetup$("myreport.pvr") | ||||||||
|
GetPaperSize( ) |
Returns the currently selected form number. Default is 0. | ||||||||
|
GetParam(idx) |
Returns the handle for an rptparam object. idx - Sequence number of the object. Name$ - Name assigned to the parameter. (The name match is not case sensitive.) This allows access to all rptparam properties and methods. Returns 0 if the sequence number is invalid. | ||||||||
|
GetParameter$(ParmName$) |
Returns the string value of a parameter. ParmName$ - Name of parameter (not case sensitive) whose value is to be returned. The name should not end with $. Returns null if a parameter with the specified name does not exist. | ||||||||
|
GetParameter(ParmName$) |
Returns the numeric value of a parameter. ParmName$ - Name of parameter (not case sensitive) whose value is to be returned. Returns 0 if ParmName$ is invalid. | ||||||||
|
GetParameterLibrary$( ) |
Returns the name of the library where the parameter interface panel is located. | ||||||||
|
GetParameterPanel$( ) |
Returns the name of the panel to be used in the user parameter interface. | ||||||||
|
GetParameterProgram$( ) |
Returns the program path and optional program label (separated by a semi-colon) to be used as the user parameter interface, or an expression (prefixed by an equals sign) that can be evaluated to determine the program name and optional label. | ||||||||
|
GetParamList$([Sep$ [,Flag$]]) |
Returns a list of parameter names. Sep$ - (Optional) Item separator (If omitted, default separator is a comma.) Flag$ - (Optional) Set to "D" to include the description in parentheses with each parameter name. Set to "V" to use variable names. (Options may be combined; i.e. "DV".) (The "D" and "V" options were added in PxPlus 2022.) | ||||||||
|
GetPostReportLogic$( ) |
Returns a string consisting of the logic type, C, X or M as the first character, followed by the logic definition string. For each logic type, the following gets returned:
(The GetPostReportLogic$ method was added in PxPlus 2022.) | ||||||||
|
GetPostReportLogicExpression$( ) |
Returns the statement that gets executed when the Post Report Logic is invoked. Call Example: call "programName",OutputDevice$, DestinationPath$,INV_NUM$ Execute Example: msgbox DestinationPath$,"Testing Post Report Logic" Method Example: If UserLogic then UserLogic'PostReportLogic(this) If the statement to be invoked is not valid, a null value is returned. (The GetPostReportLogicExpression$ method was added in PxPlus 2022.) | ||||||||
|
GetRightMargin( ) |
Returns the size of the right margin in 1000's of an inch. Printer default is indicated as -1. | ||||||||
|
GetSortDescription$( ) |
Returns a "+"-separated string consisting of the columns that make up the sort sequence. Returns null if unsuccessful. | ||||||||
|
GetSortItem(idx) |
Returns the handle for an rptsort object. idx - Sequence number of the object. This allows access to all rptsort properties and methods. Returns 0 if sequence number is invalid. | ||||||||
|
GetSortKey( ) |
Returns the key number of a pre-defined key or -1 for a custom key. | ||||||||
|
GetSourceType$( ) |
Returns a code representing the source type: P - PxPlus file with an embedded dictionary, identified by the path name | ||||||||
|
GetSystemVariable$(idx) |
Returns the specified system variable name. | ||||||||
|
GetSystemVariableCount( ) |
Returns the total number of standard system and user-defined system variables. | ||||||||
|
GetSystemVariableDescription$(idx) |
Returns the specified system variable description. | ||||||||
|
GetSystemVariableDescriptions$( ) |
Returns a string of Sep$ -separated descriptions. Default Sep$ = SEP. | ||||||||
|
GetSystemVariableLength(idx) |
Returns the maximum length of the value stored in the specified variable. | ||||||||
|
GetSystemVariables$( ) |
Returns a string of Sep$ -separated descriptions. Default Sep$ = SEP. | ||||||||
|
GetTopMargin( ) |
Returns the size of the top margin in 1000's of an inch. Printer default is indicated as -1. | ||||||||
|
GetUserOutputObject$(Level$) |
Returns the user output object for the indicated Level$:
| ||||||||
|
GroupCount( ) |
Returns the number of sections in the report. This includes the Page header, Detail Lines, Report Summary, Page footer, as well as the headers and footers for all control break group definitions. Same as BreakCount( ). | ||||||||
|
Method used in dynamic filter expressions to test the value of a field against multiple values.
(The IsAnyOf method( ) was added in PxPlus 2023.) | |||||||||
|
IsOutputNoChannel( ) |
Returns a Boolean value (0/1) indicating whether the output is not to be sent to an output channel, such as output to the clipboard. | ||||||||
|
IsOutputNoPaging( ) |
Returns a Boolean value (0/1) indicating whether the report is to be printed without page breaks. | ||||||||
|
IsOutputPrinterCompatible( ) |
Boolean value indicating whether or not the output is printer compatible, and if page properties (such as orientation and margins) are to be set up when the output device is opened. This is applicable for output to *winprt*, *pdf*, and *viewer*. This should be set to zero for HTML or Clipboard output, for example. | ||||||||
|
LibraryCount( ) |
Returns the number of associated libraries. | ||||||||
|
LineCount(Grpidx) |
Returns the number of lines in a section. Returns 0 if the argument is invalid. | ||||||||
|
LinkCount( ) |
Returns the number of related data sources that have been defined. | ||||||||
|
LoadLibraryLayout(Libname$,Libref$) |
Loads the layout specified by Libref$ from the Libname$ library so that the layout definition can be edited. Returns 1 if successful, 0 if not. | ||||||||
|
Open and initialize the report. Returns the handle for the data source object if successful. RptDefFile$ - Name of the report definition or library file. This method opens the data source and creates the sub-objects used by the Report Writer and loads them with the information contained in the definition file. If an error occurs during the execution of this method, the error will invoke the ERR= branch in the method call, so be sure to include this as part of the application program logic; e.g. sts=rpt'Open(RptDef$,err=RptErr). | |||||||||
|
Sets the output device to be the Windows clipboard, and sets the output channel to 0. Returns 1. | |||||||||
|
OutputDevice(DeviceCode$,Chan,[Opt$]) |
Generic method to set the output destination and channel. The output device is identified by a device code: C - Clipboard Chan - Sets the output channel. By default, the ReportDestinationPath$ property is cleared. In the case of report definitions generating multiple reports, the reports will be written to the output channel in a single output file. Opt$ - (Optional) Can be set to "P" to prevent clearing the ReportDestinationPath$. (The Opt$ option was added in PxPlus 2022.) | ||||||||
|
Sets the output destination to HTML and sets the output channel. The ReportDestinationPath$ property is cleared. In the case of report definitions generating multiple reports, the reports will be written to the output channel in a single physical file. Returns 1. Chan - Output channel number to an .htm file. | |||||||||
|
OutputPDF(Chan) |
Sets the output destination to PDF and sets the output channel. The ReportDestinationPath$ property is cleared. In the case of report definitions generating multiple reports, the reports will be written to the output channel in a single physical file. Returns 1. Note: | ||||||||
|
Sets the output destination to be a printer and sets the output channel. The ReportDestinationPath$ property is cleared. In the case of report definitions generating multiple reports, the reports will be written to the output channel in a single physical file. Returns 1. Chan - Output channel number to the printer device (*winprt* or *pdf*). Note: | |||||||||
|
OutputTabDelimited(Chan) |
Sets the output destination to a tab-delimited file, and sets the output channel. The ReportDestinationPath$ property is cleared. In the case of report definitions generating multiple reports, the reports will be written to the output channel in a single physical file. Returns 1. | ||||||||
|
OutputUser([Chan]) |
Sets the output destination to be a custom user output object, and sets the output channel. | ||||||||
|
OutputViewer(Chan) |
Sets the output destination to be the PxPlus Report Viewer, and sets the output channel. | ||||||||
|
ParamCount( ) |
Returns the number of defined parameters. | ||||||||
|
Processes the current data record. Processing includes dealing with control breaks, group function calculations, and outputting the data. Returns 1. | |||||||||
|
ProcessData(Record$) |
Processes the data using the data in a record. Record$ - Data record Processing includes dealing with control breaks, group function calculations, and outputting the data. Returns 1. | ||||||||
|
Reads a record from the data source. Returns the record, or null at End-of-File. | |||||||||
|
Returns the compiled IOList of all data fields from all selected data sources (i.e. main and related data sources). | |||||||||
|
RemoveAlternateCell(ObjID) |
Drop the AlternateCell rptcell object from the main rptcell object specified in ObjID and set AlternateCell to zero. | ||||||||
|
RemoveCalcField(idx) |
Removes an rptcalcfield object. idx - Sequence number of object to be removed. If an rptcalcfield object is removed, the sequence number of the rptcalcfield objects with higher sequence numbers is adjusted down. CalcFieldCount is decremented. Returns the object handle if successful, 0 if not. | ||||||||
|
RemoveCell(Grpidx,Lnidx,Cellidx) |
Removes an rptcell object. Grpidx - Sequence number of the section in which the cell is located. Lnidx - Sequence number of the line in which the cell is located. Cellidx - Sequence number of the cell to be removed. If an rptcell object is removed, the sequence number of the rptcell objects with higher sequence numbers is adjusted down. CellCount is decremented for the line. Returns the object handle if successful, 0 if not. | ||||||||
|
RemoveFilter(ObjID,Setidx,Filteridx) |
Removes an rptfilter object. ObjID - Object handle for the object containing the rptfilterset object. Current object, if omitted. Setidx - Index indicating which rptfilterset object. If not specified, defaults to the first rptfilterset object in the current object. Filteridx - Sequence number of the rptfilter object to be removed. If an rptfilter object is removed, the sequence number of the rptfilter objects with higher sequence numbers is adjusted down. FilterCount is decremented. Returns the object handle if successful, 0 if not. | ||||||||
|
RemoveFilterSet(ObjID,Setidx) |
Removes an rptfilterset object. ObjID - Object handle for the object containing the rptfilterset object. Current object, if omitted. Setidx - Sequence number of the object to be removed. If an rptfilterset object is removed, the sequence number of the rptfilterset objects with higher sequence numbers is adjusted down. FilterSetCount is decremented. Returns the object handle if successful, 0 if not. | ||||||||
|
RemoveGroup(idx) |
Removes an rptgroup object. idx - Sequence number of object to be removed. If an rptgroup object is removed, the sequence number of the rptgroup objects with higher sequence numbers is adjusted down. This removes all lines and cells associated with the section. The MultipleReports property may be adjusted depending on the setting of the NewReport property of the rptgroup object being removed. BreakCount is decremented. Returns the object handle if successful, 0 if not. Note:
| ||||||||
|
RemoveGroupFunction(idx) |
Removes an rptgroupfunc object. idx - Sequence number of object to be removed. If an rptgroupfunc object is removed, the sequence number of the rptgroupfunc objects with higher sequence numbers is adjusted down. FunctionCount is decremented. Returns the object handle if successful, 0 if not. | ||||||||
|
RemoveLine(Grpidx,Lnidx) |
Removes an rptline object and all cells associated with the line. Grpidx - Sequence number of the section in which the line is located. Lnidx - Sequence number of the line to be removed. If an rptline object is removed, the sequence number of the rptline objects with higher sequence numbers is adjusted down. LineCount is decremented for the section. Returns the object handle if successful, 0 if not. | ||||||||
|
RemoveLink(idx) |
Remove an rptlink object. idx - Sequence number of object to be removed. If an rptlink object is removed, the sequence number of the rptlink objects with higher sequence numbers is adjusted down. LinkCount is decremented. Returns the object handle if successful, 0 if not. | ||||||||
|
RemoveParam(idx) |
Removes an rptparam object. idx - Sequence number of object to be removed. If an rptparam object is removed, the sequence number of the rptparam objects with higher sequence numbers is adjusted down. ParamCount is decremented. Returns the object handle if successful, 0 if not. | ||||||||
|
RemoveSortItem(idx) |
Removes an rptsort object. idx - Sequence number of object to be removed. If an rptsort object is removed, the sequence number of the rptsort objects with higher sequence numbers is adjusted down. SortItemCount is decremented. Returns the object handle if successful, 0 if not. | ||||||||
|
ResetPrinterProperties( ) |
Resets the original printer properties. Must be preceded by the SetPrinterProperties( ) method. | ||||||||
|
Generates a report. This format gives the application program control over the report definition and output channel. The program must do all the initial setup: open the output channel, open the report definition, impose any desired changes to the definition, and get user parameters (if necessary). After the report is generated, the program must close the report and the output channel. See RunReport( ) Method. | |||||||||
|
Generate a report using default settings. Returns 1 if successful, 0 if not. RptDefFile$ - Name of the report definition file. If the printer is the defined output destination, the default printer will be used. This method can also be used to generate PDF, HTML and tab-delimited files if a ReportDestinationPath$ has been specified for the report. It can also be used to generate output files using custom output object interfaces and specifying the output file in the output object's 'DestinationFile$ property. See RunReport( ) Method. (The ability to specify the report output was added in PxPlus 2022.) | |||||||||
|
Generate a report; output to channel. RptDefFile$ - Name of the report definition file. Chan - Channel to which to output the report. The ReportDestinationPath$ property is cleared. In the case of report definitions generating multiple reports, the reports will be written to the output channel in a single physical file. The application program must first open the channel to the output device, which must be compatible with the defined output destination, and pass the channel as an argument. When the RunReport( ) method is complete, the application program must then close the channel. See RunReport( ) Method. | |||||||||
|
Save(RptDefFile$) |
Save the report definition or library currently stored in the pvxreport object and its subordinate objects. RptDefFile$ - Name of the file to which to save the report definition or library. The standard extension for report file definitions is .pvr, and .pvrlib for report libraries; however, this is not necessary. Returns 1. | ||||||||
|
SetBackgroundColor(Clr1$[,Clr2$]) |
Set up to two colours for alternating background colours on detail lines (if one colour is set, the second colour defaults to white). Use colour names ("White", "Dark Gray", "Light Red", etc.) or RGB settings; e.g. RGB:255,0,128. | ||||||||
|
SetBackgroundColorOption(Opt$) |
Set the background colour option: 0 - (Off) Report does not use alternating background colours. | ||||||||
|
SetBottomMargin(MargSize) |
Sets the size of the bottom margin. Returns 1. MargSize - Size of the margin in 1000's of an inch or -1 to set printer default. | ||||||||
|
SetColumnWidth(Col,Width) |
Sets the width of a column. Returns 1. Col - Number of column whose width is to be adjusted. Width - Width of the column, in points (72's of an inch). | ||||||||
|
SetData$(VarName$,Val$) |
Assigns a string value to a variable used in the report. VarName$ - Name of the variable to which a value will be assigned. Val$ - String value to assign to the VarName$ variable. Example: CurrentRecord$=x'SetData$("MyVar$","abc") returns the current record with the updated value. | ||||||||
|
SetData$(VarName$,Val) |
Assigns a numeric value to a variable used in the report. VarName$ - Name of the variable to which a value will be assigned. Val - Numeric value to assign to the VarName$ variable. Example: CurrentRecord$=x'SetData$("MyVar",12) returns the current record with the updated value. | ||||||||
|
SetDataSource(ds$,st$[,fo$]) |
Sets the data source to be used by the report. Arguments include: ds$ - Table name, file path, view name or data source name for a custom data source object. st$ - Source type: L (table name), P (file path), V (view name), O (custom data source object). fo$ - File object name (i.e. name of the custom data source object). For source type O only. Returns the object handle if successful, 0 if not. No arguments will reset the data source, source type and source class to null. | ||||||||
|
Creates a filter set consisting of a filter containing a free-form PxPlus expression that can be evaluated to a Boolean value (0/1). Example: InvoiceDate$>=StartDate$ AND InvoiceDate$<=EndDate$ An optional description may be included to set the DynamicFilterDescription$ property. (This can also be set individually.) Example: InvoiceDate$ is between StartDate$ and EndDate$ Returns 1 if the expression is valid. (The SetDynamicFilter( ) method was added in PxPlus 2022.) | |||||||||
|
SetDynamicFilterFields([Fields$]) |
Sets a list of fields to be included or excluded from the list of fields available for Dynamic Filters. The list consists of a + (plus sign) followed by the variables to include or a - (minus sign) followed by the variables to exclude. The field separator can be any character but should also trail the list. Example: -CST_Balance,CST_Code$, … would exclude the CST_Balance and CST_Code$ variables from the list of variables available for Dynamic filters. +Country$;Region$;State$; … would mean that only the Country$, Region$ and State$ variables would be available for Dynamic filters. If Fields$ is null or omitted, all fields are available. Returns 1. (The SetDynamicFilterFields( ) method was added in PxPlus 2022.) | ||||||||
|
SetFont(Font$) |
Sets the default font for the report. Returns 1. Font$ - Comma-separated string consisting of the font name and optionally, the negative point size and the style (B - bold and/or I - italics). Example: SetFont("Arial,-12,BI") | ||||||||
|
SetHyperlink(Groupidx,Lineidx,Cellidx,Hyperlink$,Xflg$,Option$) |
Puts an HTML hyperlink in the specified cell. (The associated text to be displayed on the report must be specified by setting the cell's Format$ and Value$ properties independently.) Where: Hyperlink$ - Hyperlink address (may be fixed literal or expression). Xflg$ - X, F or blank (Default). "X" indicates that Hyperlink$ is an expression. Option$ - Display option: 0 - Use current browser window. (Default) | ||||||||
|
SetImage(Groupidx,Lineidx,Cellidx,ImagePath$,Xflg$,DispOpt$) |
Puts an image in the specified cell. (Alternate text may be specified by setting the cell's Format$ and Value$ properties independently.) Where: ImagePath$ - Path to the image (may be fixed or expression). Xflg$ - X, F or blank (Default). "X" indicates that ImagePath$ is an expression. DispOpt$ - Display option: 1 - Original size, align top left | ||||||||
|
SetInputSort([KeyNumber]) |
Sets the key number for reading data in a custom sort. KeyNumber - Input key number for reading in the data or -1 to set it to Auto; i.e. the report generator will automatically determine the input key number. | ||||||||
|
Invokes the SetAnyOfValues( ) method in the *rpt/rptfilter class to set up a memory file for the associated IsAnyOf( ) method.
(The SetIsAnyOf method( ) was added in PxPlus 2023.) | |||||||||
|
SetLeftMargin(MargSize) |
Sets the size of the left margin. Returns 1. MargSize - Size of the margin in 1000's of an inch or -1 to set printer default. See SetPrinterProperties( ). | ||||||||
|
SetLink(idx,LinkString$) |
Populates the rptlink object and opens a channel to the related data source. idx - Sequence number for the rptlink object. LinkString$ - A string comprised of a concatenated list of LinkID$ values that represent the chain of links from the main data source to the related data source specified in the rptlink object. Returns 1 if successful, 0 if not. | ||||||||
|
SetMargins(Left,Top,Right,Bot) |
Sets all printer margins. Returns 1. Left - Left margin size Margin sizes are in 1000's of an inch. Printer default is indicated using -1. If a value is negative, then the default -1 is set. See SetPrinterProperties( ). | ||||||||
|
SetOutputChannel(Chan) |
Sets the output channel. The ReportDestinationPath$ property is cleared. In the case of report definitions generating multiple reports, the reports will be written to the output channel in a single output file. (The SetOutputChannel method was added in PxPlus 2022.) | ||||||||
|
SetOutputDevice(DevCode$) |
Sets the device to handle output. DevCode$ - Single letter code to indicate the output device: P - Printer If code is invalid, the device is set to P. Returns 1 if successful, 0 if not. | ||||||||
|
SetPageOrientation(OrCode$) |
Sets printer orientation. OrCode$ - Valid arguments are P (Portrait) or L (Landscape). Returns 1 if the argument is valid, 0 if not. See SetPrinterProperties( ). | ||||||||
|
SetParameter(Parm$,Val$) |
Sets the string value of a parameter. Parm$ - Name of parameter (not case sensitive) to be set. idx - Sequence number of the parameter to be set. Val$ - Parameter value to be assigned. May be used for string or numeric parameter values. Val - Numeric parameter value to be assigned. Returns 1 if successful, 0 if the named parameter does not exist or if value is outside defined range. | ||||||||
|
SetPaperSize(FormNumber) |
Sets the form number to use when opening a printer device. If the FormNumber is non-zero, then the PAPERSIZE=FormNumber clause will be used when opening the printer. | ||||||||
|
SetParameterPanel([Panel$,Lib$]) |
Set the name of the panel and panel library to be used in the user parameter interface. If set, the parameter program will be set to null. SetParameterPanel( ) with no arguments resets the parameter panel to null. | ||||||||
|
SetParameterProgram(Prog$[,Xflg$]) |
Set the path of the program to be used in the user parameter interface. If set, the parameter panel and library will be set to null. Prog$ - Contains the pathname of the program or an expression that will be evaluated to get the pathname. Xflg$ - "F" or "X" to indicate whether Prog$ contains a fixed value (F) or an expression (X). Example: SetParameterProgram("%ParamProgR","X"), SetParameterProgram( ) with no arguments resets the parameter program to null. | ||||||||
|
SetPostReportLogic([Type$,Logic$]) |
Specify logic to invoke when a report is complete. A report is considered complete when the report file is physically closed or, in the case where physical files are not being generated (such as output to the printer, Clipboard or Viewer), when the virtual file would logically be closed. In the case where multiple reports are being generated for individual groups using the Start New Report group option, the logic is invoked after each individual file is complete. Logic types can consist of:
When the logic is invoked, it has access to report properties, field names and method calls (using the report object handle variable THIS), which can be used as arguments. If Type$ and Logic$ are omitted or blank, the Post Report Logic is set to null. (The SetPostReportLogic method was added in PxPlus 2022.) | ||||||||
|
Sets defined printer properties. The SetMargins( ), SetLeftMargin( ), SetRightMargin( ), SetTopMargin( ), SetBottomMargin( ), and SetPageOrientation( ) must be followed by a SetPrinterProperties( ) method in order to be set. All must precede an OPEN to take effect. SetPrinterProperties( ) also saves off the original printer defaults so they can be restored using the ResetPrinterProperties( ) method. Returns 1. | |||||||||
|
Validates and sets the report destination path expression stored in the ReportDestinationPath$ property. The destination path must be a valid PxPlus expression. Returns 1 if successful, 0 if not. (The SetReportDestinationPath method was added in PxPlus 2022.) | |||||||||
|
SetRightMargin(MargSize) |
Sets the size of the right margin. Returns 1. MargSize - Size of the margin in 1000's of an inch or -1 to set printer default. See SetPrinterProperties( ). | ||||||||
|
SetScale(ScalingFactor$) |
(For Internal Use Only) Sets the scaling factor. Scaling factor is a computed fractional number greater than 0. A factor between 0 and 1 would decrease the size of the output, and a factor greater than 1 would increase the size. The scaling factor is set internally in the StartReport( ) method. | ||||||||
|
SetSort(KeyName$) |
Sets pre-defined sort sequence. Returns 1 if successful, 0 if not. KeyName$ - Name of key to be used as sort sequence. KeyNumber - Set to -1 for a custom sort. For a pre-defined sort, set to the number of the key to be used as the sort sequence. (Base 0 for primary key). InputKeyNumber - Input key number for reading in the data. | ||||||||
|
SetTopMargin(MargSize) |
Sets the size of the top margin. Returns 1. MargSize - Size of the margin in 1000's of an inch or -1 to set printer default. See SetPrinterProperties( ). | ||||||||
|
SetUserOutputObject$(Lvl$,ObjNm$[,Xflg$]) |
Set the name of the user output object for the specified level. Lvl$ - Level at which to apply the output object: D - Default level ObjNm$ - Contains the name of the object or an expression that will be evaluated to get the object name. Xflg$ - "F" or "X" to indicate whether ObjName$ contains a fixed value (F) or an expression (X). | ||||||||
|
SortItemCount( ) |
Returns the number of segments in the sort sequence. | ||||||||
|
Source( ) |
Returns the handle for the data source object. | ||||||||
|
SourceIolist$( ) |
Returns the data source IOList in compiled format. | ||||||||
|
Returns the key IOList in compiled format for data sources with external keys. | |||||||||
|
Initialize the workspace required to generate the report. Returns 1. | |||||||||
|
StaticSourceIolist$( ) |
Returns a data source IOList in compiled format that can be used to declare a Static IOL (i.e. variables have no formatting). | ||||||||
|
_InitInternalLibraryBlock( ) |
(For Internal Use Only) | ||||||||
|
_LoadInternalLibraryBlock( ) |
(For Internal Use Only) |