Skip to content

Methods for cWinReport2

View method list in alphabetical order.

Name Type Description Defining Class
Add_SubTotal Procedure Adds the value of nData to the subtotal for the passed iCounter cWinReport2
ArePrintersInstalled Function Returns true if printers are installed cWinReport2
Clr_AllSubTotals Procedure Zeroes all the subtotal accumulators for the report cWinReport2
Clr_SubTotal Procedure Zeroes the subtotal accumulator for the passed iCounter cWinReport2
DFClearDoc Procedure DFClearDoc clears the generated report cWinReport2
DFClearPrinter Procedure Clears the printer data channel and the printer settings cWinReport2
DFClosePreview Procedure Closes the report viewer cWinReport2
DFEndDocument Procedure Specifies that a report is complete cWinReport2
DFGetCurrentDevice Function Returns the name of the current print device cWinReport2
DFGetDFColor Function Converts individual R(ed), G(reen), B(lue) values into a WinPrint2 color value. cWinReport2
DFGetEnablePrintFromPreview Function Determines is printing is allowed within the WinPrint2 report viewer cWinReport2
DFGetLandscape Function Determines if a report page orientation should be Landscape or Portrait cWinReport2
DFGetMetrics Function Returns the metrics used by the report cWinReport2
DFGetPrintDlgInPreview Function Determines if the print job dialog will appear when the viewer's print button is pressed cWinReport2
DFGetPrinterBin Function Determines the bin source for a report cWinReport2
DFGetPrinterPaper Function Determines the paper type/size used in a report cWinReport2
DFGetPrinterResolution Function Determines the printer resolution used in a report cWinReport2
DFGetUserDefinedLength Function Returns the length for user defined paper cWinReport2
DFGetUserDefinedWidth Function Returns the width for user defined paper cWinReport2
DFNew_Page Procedure Outputs a new page cWinReport2
DFPreview Procedure Opens the printer viewer cWinReport2
DFPreviewNoWait Procedure Opens the printer viewer as a modeless viewer cWinReport2
DFPreviewWait Procedure Opens the printer viewer as a modal viewer cWinReport2
DFPrint Procedure Invokes the printer job dialog and prints the document using current settings in the print setup cWinReport2
DFPrintDialog Procedure Invokes the WinPrint2 Print Job Dialog cWinReport2
DFPrintDoc Procedure Prints the document without invoking the Print Job Dialog cWinReport2
DFPrinterBinFirstPage Procedure Allows you to set a different printer bin for report's first page cWinReport2
DFPrintSetup Procedure Invokes the the Printer Setup Dialog allowing the user to select a printer cWinReport2
DFPrintSetupDialog Function Invokes the the Printer Setup Dialog allowing the user to select a printer cWinReport2
DFSetDevice Procedure Sets the location and name of the print device cWinReport2
DFSetEnablePrintFromPreview Procedure Determines if WinPrint2 viewer allows printing cWinReport2
DFSetLandscape Procedure Sets a report's orientation to Landscape or Portrait cWinReport2
DFSetMargins Procedure Sets Left, Top, Right and Bottom Margins for a report cWinReport2
DFSetMetrics Procedure Sets a report's metrics to centimeters or Inches cWinReport2
DFSetNumberOfCopies Procedure Sets the number of copies to printed cWinReport2
DFSetPrintDlgInPreview Procedure Determines if the print job dialog will appear when printing is selected from the WinPrint2 viewer cWinReport2
DFSetPrinterBin Procedure Sets the printer bin to be used in a report cWinReport2
DFSetPrinterPaper Procedure Sets the paper type/size for a report cWinReport2
DFSetPrinterResolution Procedure Sets the printer resolution used in a report cWinReport2
DFSetTopBottom Procedure Sets the top and bottom margins used by the Page_Top and Page_Bottom sections cWinReport2
DFSetUserDefinedPapersize Procedure Sets the length and width of a user defined papersize cWinReport2
DocumentStatus Function Returns the status of a report cWinReport2
EndMultiReport Procedure Ends a linked multi-report cWinReport2
IsPrinterValid Function cWinReport2
IsViewerActive Function Returns true of the Winprint2 viewer is actve cWinReport2
PrintReport Procedure Outputs the current report to printer or viewer based on output_device_mode cWinReport2
RGBToWPColor Function Converts a standard RGB color to a Winprint RGB color value cWinReport2
ShowRuler Procedure Displays a ruler in the report cWinReport2
SubTotal Function Returns the appropriate subtotal and clears the subtotal accumulator cWinReport2
Sum_SubTotal Function Returns the value of the subtotal for the passed iTotal, but does not zero the subtotal accumulator cWinReport2
Update_Status Procedure Updates a report's status in the report viewer cWinReport2

Inherited Methods from BasicReport

Name Type Description Defining Class
End_Log Procedure Sends an end-log message to the log object BasicReport
Error_Log_Status Procedure Called by Error_Report if Status_Log_State is True BasicReport
Log_Status Procedure Sends passed message to the log object BasicReport
Start_Log Procedure Sends a start-log message to the log object BasicReport
Update_Status Procedure Send this message to update the action area of the status panel BasicReport

Inherited Methods from Report_DS

Name Type Description Defining Class
Request_Delete Procedure If sent (usually in the body) this will delete the current record through the DDO Report_DS
Request_Save Procedure If sent, this saves the current record Report_DS

Inherited Methods from Report

Name Type Description Defining Class
FormFeed Procedure Handles formfeeds Report
Output_ImageNum Procedure Outputs the image represented by ImageNum Report
Run_Report Procedure Sends a message to the report object telling it to start the report with internal finding Report
Start_Report Function Augmented to check the server property and if the property is non-zero (and a DSO exists), to establish a client-server link between the report object and the DSO Report
Writeln Procedure Outputs the string message to the current output channel Report
Writeln_PageCheck Procedure Allows you to output to your report with non-image data Report

Inherited Methods from cObject

Name Type Description Defining Class
ChildByIndex Function Can be used to iterate the direct children of an object cObject
ClassSuperClass Function Returns the superclass of the passed class cObject
Create Function Creates an object based on the passed Class Id cObject
CreateNamed Function Creates an object based on the passed Class Id and assigns it a name Name based on a passed name cObject
Destroy Procedure Destroys the object that receives the message and any child objects of that object cObject
Exit_Application Procedure Starts the process of closing an application cObject
IsClassOfClass Function Determines whether the target class is part of the searched class's hierarchy cObject
IsObjectOfClass Function Determines whether the passed class is part of the object's class hierarchy cObject
ObjectClass Function Returns the integer class ID assigned to the class this object is based on cObject
Request_Destroy_Object Procedure Use the Destroy method instead cObject