Methods for cWinReport2
View method list in hierarchical order.
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Add_SubTotal | Procedure | Adds the value of nData to the subtotal for the passed iCounter The Add_subtotal procedure adds the value of nData to the subtotal for the passed iCounter. | cWinReport2 |
| ArePrintersInstalled | Function | Returns true if printers are installed Returns true if printers are installed. | cWinReport2 |
| ChildByIndex | Function | Can be used to iterate the direct children of an object ChildByIndex is a function that can be used to iterate the direct children of an object. | cObject |
| ClassSuperClass | Function | Returns the superclass of the passed class This returns the superclass of the passed class. | cObject |
| Clr_AllSubTotals | Procedure | Zeroes all the subtotal accumulators for the report The Clr_AllSubtotals procedure zeroes all the subtotal accumulators for the report. | cWinReport2 |
| Clr_SubTotal | Procedure | Zeroes the subtotal accumulator for the passed iCounter The Clr_subtotal procedure zeroes the subtotal accumulator for the passed iCounter. | cWinReport2 |
| Create | Function | Creates an object based on the passed Class Id The Create function is used to dynamically create objects. | cObject |
| CreateNamed | Function | Creates an object based on the passed Class Id and assigns it a name Name based on a passed name 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 The Destroy message destroys the object that receives the message. | cObject |
| DFClearDoc | Procedure | DFClearDoc clears the generated report DFClearDoc clears the generated report document in memory, but leaves the printer settings unchanged. | cWinReport2 |
| DFClearPrinter | Procedure | Clears the printer data channel and the printer settings DFClearPrinter will clear the printer data channel and the printer settings. | cWinReport2 |
| DFClosePreview | Procedure | Closes the report viewer DfClosePreview closes the report viewer. | cWinReport2 |
| DFEndDocument | Procedure | Specifies that a report is complete DfEndDocument changes a report's mode from started (dsStarted) to finished (dsFinished). | cWinReport2 |
| DFGetCurrentDevice | Function | Returns the name of the current print device DFGetCurrentDevice returns the location and 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 DFGetEnablePrintFromPreview can be used to determine if printing is allowed from within the report viewer. | cWinReport2 |
| DFGetLandscape | Function | Determines if a report page orientation should be Landscape or Portrait The DFGetLandscape function returns true if the report's orientation is landscape. | cWinReport2 |
| DFGetMetrics | Function | Returns the metrics used by the report DFGetMetrics returns the metrics, centimeters or inches, 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 DFGetPrinterBin returns the bin source used by the current report. | cWinReport2 |
| DFGetPrinterPaper | Function | Determines the paper type/size used in a report DFGetPrinterPaper returns the paper size used in a report. | cWinReport2 |
| DFGetPrinterResolution | Function | Determines the printer resolution used in a report DFGetPrinterResolution returns the printer resolution used in a report. | cWinReport2 |
| DFGetUserDefinedLength | Function | Returns the length for user defined paper DFGetUserDefinedLength returns the width of user defined paper. | cWinReport2 |
| DFGetUserDefinedWidth | Function | Returns the width for user defined paper DFGetUserDefinedWidth returns the width of user defined paper. | cWinReport2 |
| DFNew_Page | Procedure | Outputs a new page The DFNew_page procedure creates a new page. | cWinReport2 |
| DFPreview | Procedure | Opens the printer viewer DFPreview opens the printer viewer with your document. | cWinReport2 |
| DFPreviewNoWait | Procedure | Opens the printer viewer as a modeless viewer DFPreviewNoWait opens the printer viewer with your document. | cWinReport2 |
| DFPreviewWait | Procedure | Opens the printer viewer as a modal viewer DFPreviewWait opens the printer viewer with your document. | 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 DFPrintDialog invokes the the Print Job Dialog. | cWinReport2 |
| DFPrintDoc | Procedure | Prints the document without invoking the Print Job Dialog DFPrintDoc prints the current generated report without invoking the Print Job Dialog. | cWinReport2 |
| DFPrinterBinFirstPage | Procedure | Allows you to set a different printer bin for report's first page DFPrinterBinFirstPagesets the printer bin to used for the first page in a report. | cWinReport2 |
| DFPrintSetup | Procedure | Invokes the the Printer Setup Dialog allowing the user to select a printer This method has been replace by DFPrintSetupDialog. | cWinReport2 |
| DFPrintSetupDialog | Function | Invokes the the Printer Setup Dialog allowing the user to select a printer DFPrintSetupDialog invokes the printer setup dialog. | cWinReport2 |
| DFSetDevice | Procedure | Sets the location and name of the print device DFSetDevice sets print device. | cWinReport2 |
| DFSetEnablePrintFromPreview | Procedure | Determines if WinPrint2 viewer allows printing When a report is started, the report object always enables printing from the viewer. | cWinReport2 |
| DFSetLandscape | Procedure | Sets a report's orientation to Landscape or Portrait The DFSetLandscape method is used to explicitlly set a report's orientation. | cWinReport2 |
| DFSetMargins | Procedure | Sets Left, Top, Right and Bottom Margins for a report DFSetMargins sets margins in your report using the report's current metrics. | cWinReport2 |
| DFSetMetrics | Procedure | Sets a report's metrics to centimeters or Inches Before running a report you must specify if the report will use Inches or Centimeters for its metrics. | cWinReport2 |
| DFSetNumberOfCopies | Procedure | Sets the number of copies to printed DFSetNumberOfCopies determines 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 DFSetPrinterBin sets the printer bin used in a report. | cWinReport2 |
| DFSetPrinterPaper | Procedure | Sets the paper type/size for a report DFSetPrinterPaper determines the type/size of paper to be used in a report. | cWinReport2 |
| DFSetPrinterResolution | Procedure | Sets the printer resolution used in a report DFSetPrinterResolution determines the printer resolution to be used in a report. | cWinReport2 |
| DFSetTopBottom | Procedure | Sets the top and bottom margins used by the Page_Top and Page_Bottom sections DFSetTopBottom sets the top margin for Page_Top and the bottom margin for Page_Bottom. | cWinReport2 |
| DFSetUserDefinedPapersize | Procedure | Sets the length and width of a user defined papersize DFSetUserDefinedPapersize sets a paper size width and length using the current metrics. | cWinReport2 |
| DocumentStatus | Function | Returns the status of a report | cWinReport2 |
| End_Log | Procedure | Sends an end-log message to the log object End_log sends an end-log message to the log object. | BasicReport |
| EndMultiReport | Procedure | Ends a linked multi-report Normally, a report object represents a single report. | cWinReport2 |
| Error_Log_Status | Procedure | Called by Error_Report if Status_Log_State is True | BasicReport |
| Exit_Application | Procedure | Starts the process of closing an application The Exit_Application message is used to close the program. | cObject |
| FormFeed | Procedure | Handles formfeeds FormFeed handles formfeeds. | Report |
| 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 This returns True if the passed class is part of the object's class hierarchy. | cObject |
| IsPrinterValid | Function | cWinReport2 | |
| IsViewerActive | Function | Returns true of the Winprint2 viewer is actve The IsViewerActive function returns true if the WinPrint2 report is active (i.e., it is paged). | cWinReport2 |
| Log_Status | Procedure | Sends passed message to the log object Log_status sends passed message to the log object. | BasicReport |
| ObjectClass | Function | Returns the integer class ID assigned to the class this object is based on Returns the integer class ID assigned to the class this object is based on. | cObject |
| Output_ImageNum | Procedure | Outputs the image represented by ImageNum Output_imagenum outputs the image represented by ImageNum. | Report |
| PrintReport | Procedure | Outputs the current report to printer or viewer based on output_device_mode | cWinReport2 |
| Request_Delete | Procedure | If sent (usually in the body) this will delete the current record through the DDO If Request_delete is sent (usually in the body) this will delete the current record through the DDO. | Report_DS |
| Request_Destroy_Object | Procedure | Use the Destroy method instead This method is used to destroy an object and all of its children. | cObject |
| Request_Save | Procedure | If sent, this saves the current record If Request_Save is sent, this saves the current record. | Report_DS |
| RGBToWPColor | Function | Converts a standard RGB color to a Winprint RGB color value The RGB values used by WinPrint2 are different than the RGB color values used by the rest of DataFlex (which uses standard RGB values). | cWinReport2 |
| Run_Report | Procedure | Sends a message to the report object telling it to start the report with internal finding Run_report sends a message to the report object telling it to start the report with internal finding. | Report |
| ShowRuler | Procedure | Displays a ruler in the report When sent, the ShowRuler message displays a ruler in the report. | cWinReport2 |
| Start_Log | Procedure | Sends a start-log message to the log object The Start_Log procedure sends a start-log message to the log object. | BasicReport |
| 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 |
| SubTotal | Function | Returns the appropriate subtotal and clears the subtotal accumulator The Subtotal function returns the value of the subtotal for the passed iTotal and zeroes 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 The update_status message is augmented in this class to direct the status update string to the report viewer. | cWinReport2 |
| Writeln | Procedure | Outputs the string message to the current output channel Writeln outputs the string message to the current output channel. | Report |
| Writeln_PageCheck | Procedure | Allows you to output to your report with non-image data Writeln_pageCheck allows you to output to your report with non-image data. | Report |