Module Winprint2.pkg

WinPrint2.pkg

Winprint2.pkg (view source)
• import declarations
  • Windows.pkg (view source)
  • LanguageText.pkg (view source)
  • Dll.pkg (view source)
  • WinPrint2_API.pkg (view source)
  • Winprint_Constants.pkg (view source)
  • Rgb.pkg (view source)
  • GlobalFunctionsProcedures.pkg (view source)
  • GlobalFunctionsProcedures.pkg (view source)
• DWordWaitForSingleObject(Handle hHandle Dword dwMilliseconds)
• DWordGetCurrentProcessId()
• DWordGetCurrentProcess()
• DwordMsgWaitForMultipleObjects(DWORD nCount Address pHandles Boolean fWaitAll DWORD dwMilliseconds DWORD dwWakeMask)
  number of handles in the object handle array pointer to the object-handle array wait for all or wait for one time-out interval in milliseconds type of input events to wait for
• cWinPrint2 : cObject
  JJT: Will we need a windows handle for this like old one
  • Construct_Object()
    • IntegerDFCurrent_Color
      *** internal properties
    • StringDFCurrent_OutPut
    • IntegerDFCurrent_Diagram
    • IntegerDFCurrent_HeaderType
    • IntegerDFCurrent_HeaderNr
    • NumberDFCurrent_FontSize
    • StringDFCurrent_Font
    • NumberDFLeft_Margin
      *** Default values for margins 2.53 CM = 1 inch
    • NumberDFTop_Margin
    • NumberDFright_Margin
    • NumberDFBottom_Margin
    • IntegerPrintDlgInPreview
      If WP1 this defaults to false. In 2, it is true which means that the print job dialog appears when you hitprint in previewer.
    • IntegerEnablePrintSetupFromPreview
      This does nothing in Wp2 (because you can't to this anyway)
    • IntegerEnablePrintFromPreview
    • IntegerpbIsSuspended
      is the GUI Suspended. This is privately maintained and is used to figure out if a preview panel is up or not
    • oDFColorArray : Array
    • oDiagramArray : Array
  • BooleanViewerWantsToClose()
  • booleanIsViewerActive()
  • BooleanIsPrinterValid()
  • booleanArePrintersInstalled()
  • IntegerDocumentStatus()
    returns docucument state: dsNotStarted, dsStarted, dsFinished
  • DFZeroCounters()
    Might still be called from report class. Leave dummy stub
  • IntegerDFNewPage(Integer Columns)
    ***
    • IntegeriPageNum
  • handleReport_Window_Handle()
    ***Return handle to use for winprint dialog. If main_window exists, use it. Else, get object's handle
    • IntegerhWnd
    • IntegerhoObj
  • BooleanDFPrintDialog()
    ***
    • Integerhwnd
    • BooleanbOk
  • BooleanDFPrintSetupDialog()
    *** You can only invoke the print setup if the report is cleared. If you try to to do this in the wrong state you will get an error.
    • Integerhwnd
    • BooleanbOk
    • IntegeriStatus
  • DFPrintSetup()
    *** Provided for backwards compatibility. DFPrintSetupDialog is more flexible because it returns a false if cancel was selected.
    • BooleanbOk
  • DFPrint()
    *** This invokes the print job dialog, prints the report, then clears the report document. This should be called after the report is complete.
    • IntegerbOk
  • DFSuspendGui(boolean bSuspend)
  • PumpMsgQueue()
    this is protected so that the queue is only pumped if the gui is suspended.
  • DFPreviewNoWait()
    *** This does a modeless preview. This is what you'd want during report generation and it may be what you want for report viewing.
    • BooleanbOk
    • BooleanbPrntDlg
    • BooleanbPrintSetup
    • BooleanbPrint
    • IntegeriStatus
  • DFPreviewWait()
    *** This does a modal preview. You might want this for report viewing as the program knows when the viewer is closed Note that this is a private message and it was never intended that this should be used. We expect winprint reports to use modeless viewers.
    • IntegerhViewerProcess
    • BooleanbPrntDlg
    • BooleanbPrintSetup
    • BooleanbPrint
    • IntegeriRetVal
    • IntegerhwMain
    • IntegerhMain
  • DfPreview()
  • DFPrintDoc()
    ***
    • Integerhwnd
    • BooleanbOk
  • DFClearDoc()
    ***
    • BooleanbOk
  • DFNewDoc(Boolean bAutoPreview)
    • BooleanbOk
  • DFSetFont(String sFontName)
    ***
    • BooleanbOk
  • DFSetFontSize(Integer iHeight Integer iWidth)
    ***
    • BooleanbOk
  • DFSetFontStyle(DWORD dwStyle)
    ***
    • BooleanbOk
  • DFSetUnderline(boolean bUnderline)
    ***
    • BooleanbOk
  • DFSetBold(Boolean bBold)
    ***
    • BooleanbOk
  • DFSetItalic(Boolean bItalic)
    ***
    • BooleanbOk
  • DFSetStrikeout(Boolean bStrikeout)
    ***
    • BooleanbOk
  • DFSetMargins(Number nLeft Number nTop Number nRight Number nBottom)
    ***
    • BooleanbOk
    • IntegeriLeft
    • IntegeriRight
    • IntegeriTop
    • IntegeriBottom
  • DFSetLeftMargin(Number nLeft)
    ***
    • NumbernTop
    • NumbernRight
    • NumbernBottom
  • DFSetRightMargin(Number nRight)
    ***
    • NumbernLeft
    • NumbernTop
    • NumbernBottom
  • DFSetTopMargin(Number nTop)
    ***
    • NumbernLeft
    • NumbernRight
    • NumbernBottom
  • DFSetBottomMargin(Number nBottom)
    ***
    • NumbernLeft
    • NumbernTop
    • NumbernRight
  • DFWriteText(String sText Integer iStyle Integer iColumn Integer iDecimal Boolean bNewLineAfterPrint)
    ***
    • BooleanbOk
  • DFWrite(String sText DWORD iStyle Integer iColumn Integer iDecimal Boolean bTrim)
    ***
  • DFWriteLn(String sText DWORD iStyle Integer iColumn Integer iDecimal Boolean bTrim)
    ***
  • DFWriteTextAtPosition(String sText integer iStyle Number nPosition Integer iDecimal Number nMaxLength Boolean bNewLineAfterPrint)
    ***
    • BooleanbOk
    • IntegeriPosition
    • IntegeriMaxLength
  • DFWritePos(String sText integer iStyle Number nPosition Integer iDecimal Number nMaxLength boolean bTrim)
    ***
    • NumbernMax
  • DFWriteLnPos(String sText integer iStyle Number nPosition Integer iDecimal Number nMaxLength boolean bTrim)
    ***
    • NumbernMax
  • DFSetMetrics(String sMetrics)
    • IntegereMetrics
  • IntegerDFGetMetrics()
    • IntegereMetrics
  • stringDFCurrent_Metrics()
    **** Properties Maintained for compatibility with old Winprint (obsolete)
    • IntegereMetrics
  • Set(string sCMorINCH)
  • DFBeginHeaderType(Integer iHeaderNr Integer eHeaderType)
    ***
    • BooleanbOk
  • DFEndHeaderType()
    ***
    • BooleanbOk
  • DFWriteHeaderType(Integer iHeaderNr Integer eHeaderType)
    ***
    • BooleanbOk
  • DFHeaderPosition(Integer ePlace)
    ***
    • BooleanbOk
  • DFHeaderFrameType(Integer eFrame integer iColor Number nWeight Integer iFillColor Boolean bFillFrame)
    ***
    • IntegeriWeight
    • BooleanbOk
  • DFHeaderMargin(Integer eType Number nSize)
    • BooleanbOk
    • IntegeriSize
  • DFHeaderWrap(Integer eOnOff)
    ***
    • BooleanbOk
  • DFWriteBMP(String sFileName Number nStartX Number nStartY Number nHeight Number nWidth Boolean bUCp)
    ***
    • BooleanbOk
    • IntegeriStartX
    • IntegeriStartY
    • IntegeriHeight
    • IntegeriWidth
  • DFHeaderLineCheck(Integer iLines)
    ***
    • BooleanbOk
  • DFPrintFlags(Integer Flags)
    ***
    • BooleanbOk
  • DFSelectPrinter(String sDriver String sDevice String sPort Boolean bUpdate)
    *** obsolete and maintained for winprint-I backwards compatibility (maybe should be removed)
  • DFSetDevice(String sDevice)
    *** Preferred usage for WinprintII
    • BooleanbOk
  • DFPrinterBinFirstPage(Integer eBin)
    • BooleanbOk
  • IntegerDFGetDFColor(Integer iRed Integer iGreen Integer iBlue)
    ***
    • IntegeriColor
  • DFSetDFColor(Dword dwColor)
    ***
    • IntegerbOk
  • DFSetTopBottom(Number nTop Number nBottom Boolean bAllPages)
    ***
    • BooleanbOk
    • IntegeriTop
    • IntegeriBottom
  • DFSetJMode(Integer eAlign)
    ***
    • BooleanbOk
  • DFWriteEllip(Number nStartX Number nStartY Number nHeight Number nWidth Dword dwBColor Dword dwFColor Boolean bFill Number nWeight Boolean bWrap Boolean bUCp)
    ***
    • BooleanbOk
    • IntegeriWeight
    • IntegeriStartX
    • IntegeriStartY
    • IntegeriHeight
    • IntegeriWidth
  • DFWriteRect(Number nStartX Number nStartY Number nHeight Number nWidth Dword dwBColor Dword dwFColor Boolean bFill Number nWeight Boolean bWrap Boolean bUCp)
    ***
    • BooleanbOk
    • IntegeriWeight
    • IntegeriStartX
    • IntegeriStartY
    • IntegeriHeight
    • IntegeriWidth
  • DFLineCheck(Integer iLines)
    ***
    • BooleanbOk
  • DFCreateDiagram(Integer eType Integer eFx Number nHeight Number nWidth Integer bXyAxis)
    ***
    • IntegerhDiagram
    • IntegeriWidth
    • IntegeriHeight
  • DFDiagram_Item(handle hDiagram String sLabel Number nValue Dword dwBColor Dword dwFColor Integer eFill Integer iDec Integer eValueOrPercent Integer eExt)
    ***
    • BooleanbOk
    • IntegeriCurrColor
    • IntegeriValue
  • DFLockDiagram(Handle hDiagram)
    ***
    • BooleanbOk
  • DFDrawDiagram(Handle hDiagram Number nYPos Number nXPos Boolean bUCp)
    ***
    • BooleanbOk
    • IntegeriXPos
    • IntegeriYPos
  • DFDiagramLabel(handle hDiagram String sLabel)
    ***
    • BooleanbOk
    • IntegeriLabelLen
  • DFDiagramXLabel(handle hDiagram String sLabel)
    ***
    • BooleanbOk
  • DFDiagramYLabel(handle hDiagram String sLabel Boolean bVertical)
    ***
    • BooleanbOk
  • DFWriteXYLine(Number nStartX Number nStartY Number nStopX Number nStopY Dword dwColor Number nWeight Boolean bWrap Boolean bUCp)
    ***
    • BooleanbOk
    • IntegeriStartX
    • IntegeriStartY
    • IntegeriStopX
    • IntegeriStopY
    • IntegeriWeight
  • DFWriteLine(Number nStartX Number nStartY Number nLength Boolean bHorizontal Dword dwColor Number nWeight Boolean bUCp)
    ***
    • BooleanbOk
    • IntegeriStartX
    • IntegeriStartY
    • IntegeriLength
    • IntegeriWeight
  • DFClearPrinter()
    ***
    • BooleanbOk
  • StringDFGetCurrentDevice()
    ***
    • BooleanbOk
    • StringsDFStr
    • AddresspDFStr
  • DwordDFGetPrintDialogFlags()
    Note: DfGetCurrentPort and DFGetCurrentDriver do not exist in winprint2. Trying to use these will result in a runtime error (which is good - don't use them) ***
    • IntegerdwRetVal
  • BooleanDFCheckPrintDialogFlag(Dword dwPDFlag)
    *** *** Returns PRN_TRUE= if the flag is set (1) *** Returns PRN_FALSE= If the flag not is set (0) ***
    • BooleanbIsSet
  • DFSetSpecPrintFlag(Dword dwPDFlag)
    ***
    • BooleanbOk
  • NumberDFGetUserDefinedLength()
    ***
    • IntegeriRetVal
    • NumbernRetVal
  • NumberDFGetUserDefinedWidth()
    ***
    • IntegeriRetVal
    • NumbernRetVal
  • DFSetUserDefinedPapersize(Number nLength Number nWidth)
    *** To be set in CM
    • IntegerbOk
    • IntegeriLength
    • IntegeriWidth
    • IntegeriSize
  • DFSetNumberOfCopies(Integer iNrOfCopies)
    • BooleanbOk
  • IntegerDFGetCurrentDiagram()
    ************************************************************* *** This procedures and functions are used when building *** *** complex graphics when you need to change value of the *** *** current diagram, so you can mix diagrams within each *** *** other. *** *************************************************************
    • IntegeriRetVal
  • DFSetCurrentDiagram(Integer iDiagram)
  • DFSetDiagramList(Integer iItem Integer iDiagram)
  • IntegerDFGetDiagramList(Integer iItem)
    • IntegeriRetVal
  • DFClearDiagramList()
  • DwordDFGetColor(Integer iColor)
    • IntegerdwRetVal
  • DwordDFGetCurrentColor()
    • IntegerdwRetVal
    • IntegeriCurrColor
  • DFEndDocument()
    • IntegeriVoid
  • DFClosePreview()
    • IntegeriVoid
  • SetProgressCaption(string sCaption)
    • IntegeriVoid
  • SetReportTitle(string sTitle)
    • IntegeriVoid
  • integerPreviewYesNoBox(string sCaption string sText)
    • IntegereResult
  • integerPrintFlagRange(integer iTopVal integer iStep)
    internal function, used to extract different printer flags ranges based on the print flag integer. These flags use a decimal style of packing information where different printer options (paper, bin, etc) use different ranges and different steps. Everything above iTopVal is removed and everything that is not within the iStep range is removed.
    • IntegeriFgs
    • IntegeriFg
  • DFSetPrinterPaper(integer ePaperType)
  • integerDFGetPrinterPaper()
    ePaperType
    • IntegerePaperType
  • DFSetPrinterBin(integer eBinType)
  • integerDFGetPrinterBin()
    eBinType
    • IntegereBinType
  • DFSetPrinterResolution(integer eResType)
  • integerDFGetPrinterResolution()
    eResType
    • IntegereResType
  • DFSetLandscape(boolean bIsLandscape)
  • booleanDFGetLandscape()
    bIsLandscape
    • BooleanbIsLandscape
  • integerRGBToWPColor(integer iRgb)
    • IntegeriRed
    • IntegeriGreen
    • IntegeriBlue
    • IntegeriWPColor
• IntegerghoWinPrint2

References (1):

Field References (0):