Class: cWinReport2
Class Hierarchy:
cObject

Report


Report_DS



BasicReport




cWinReport2Class Definition
Properties
Boolean
AutoNew_Page_State
This determines if a DFNew_Page should be executed when the
report starts. In some rare cases, you would not want this to
occur until a subheader
Boolean
AutoOutput_State
If true, report is output upon completion. Either preview
or printer depending on output_device_mode
boolean
pbFirstPagePrinted
boolean
pbModalViewer
JJT: For now this is for testing.
boolean
pbMultiReports
Handle
phoWinPrint
the report engine to use.
Integer
Print_Columns
When a new page is created (DFNew_Page) and the number
of columns is not passed, this is used.
Integer
Private.Output_Device_Mode
Output device (print or preview). Normally this is delegated to
the report view.
Date
RptToday
should use built in DF function CurrentDateTime()
Functions and Procedures

Add_SubTotal(Integer iCounter Number nData)
All subtotal commands use the outer main report. This makes it easier to keep
track of these numbers
Boolean
ArePrintersInstalled()

Close_Output_Device()
Cancel RO behavior - there is no device to close

Clr_AllSubTotals()

Clr_SubTotal(Integer iCounter)

Construct_Object()

DFClearDoc()
clear document, remove viewer

DFClearPrinter()

DFClosePreview()
close the previewer, does not clear the document

DFEndDocument()
tell winprint that the report is complete
string
DFGetCurrentDevice()
sPrinterName
integer
DFGetDFColor(integer iRed integer iGreen integer iBlue)
boolean
DFGetEnablePrintFromPreview()
boolean
DFGetLandscape()
bIsLandscape
integer
DFGetMetrics()
boolean
DFGetPrintDlgInPreview()
integer
DFGetPrinterBin()
eBinType
integer
DFGetPrinterPaper()
ePaperType
integer
DFGetPrinterResolution()
eResType
number
DFGetUserDefinedLength()
number
DFGetUserDefinedWidth()

DFNew_Page(Integer Cols)
Note: Cols is optional. If no argument is passed it will use
the object's property Print_Columns (0 by default)

DFPreview()
invokde previewer based on pbModalViewer property

DFPreviewNoWait()
invoke previwer in modeless mode

DFPreviewWait()
invoke previewer in modal mode

DFPrint()
print with printer dialog

DFPrintDialog()
popup print job dialog

DFPrintDoc()
print without printer dialog

DFPrinterBinFirstPage(integer eBinType)

DFPrintSetup()
It is better to use DFPrintSetupDialog which tells you if the dialog was canceled
invoke printer setup dialog
Boolean
DFPrintSetupDialog()
Attempt to make this as intuitive as possible. You cannot invoke this when a
report is active. If a report is not finished, you cannot do this.
If a report is finsihed it may or may not have a viewer present.
If a viewer is not present, we will clear the exising report (making the assumption
that a modeless viewer was closed and the report will not be invoked again). If a viewer
is active, we will pass this through to the winprint object which will show an error
invoke printer setup dialog

DFSetDevice(string sPrinterName)

DFSetEnablePrintFromPreview(boolean bEnablePrint)

DFSetLandscape(boolean bIsLandscape)

DFSetMargins(number nLeft number nTop number nRight number nBottom)

DFSetMetrics(integer eType)

DFSetNumberOfCopies(integer iCopies)

DFSetPrintDlgInPreview(boolean bShowDialog)

DFSetPrinterBin(integer eBinType)

DFSetPrinterPaper(integer ePaperType)

DFSetPrinterResolution(integer eResType)

DFSetTopBottom(number nTop number nBottom Boolean bAllPages)

DFSetUserDefinedPapersize(number nLength number nWidth)
Boolean
DocumentStatus()
returns the current status of Winprint Document object. dsNotStarted, dsStarted, dsFinished
note that the status can reflect a status from a different report. The winprint object is global.

End_Status()

Ending_Main_Report()

EndMultiReport()
This must get called when you are running multiple reports (pbMultiReport).
Send this when the last report is complete.

EndWinPrintReport()

Initialize_Output_Device()
Cancel RO Behavior
Boolean
IsPrinterValid()
Boolean
IsViewerActive()

OnClosingView()
Integer
Output_Device_Mode()

PrintReport()
Print report to appropriate device (printer, preview) based
on output_device_mode
Integer
Report_Interrupt()

Resume_Status()
integer
RGBToWPColor(integer iRgb)

Set(Integer DevMode)
Integer
Setup_Report()

ShowRuler()
displays a metric ruler in .5 increments. This can be
sent to make it easy to see how fields and labels should
be moved for alignment.

Start_Status()
Number
SubTotal(Integer iTotal)
Return sub-total and clear accumulator
Number
Sum_SubTotal(Integer iTotal)
Integer
Test_KeyPressed()

Update_Status(string sVal)
status panel related agumentations to handle the auto-previewer
Instances
oCustomer_BasicReport | CustomerListBR.rv | 136 |
References (6):