Module cCrystal.pkg

cCrystal.pkg (view source)

import declarations
IntegerghoCrystalReportServer
cCrystalReport : cComAutomationObject
- Construct_Object()
  Inherited from cComAutomationObject
  - StringpsReportLocation
    Path to report file that was opened.
  - HandlephoDatabase
    available objects within the report class
  - HandlephoDatabaseTables
  - HandlephoFormulaFieldDefinitions
  - HandlephoParamFieldDefinitions
  - HandlephoSortFields
  - Handle[]phoParams
    holds handles of all paramterFieldDefinition objects
  - Handle[]phoTables
    holds handles of all table objects
  - tCRWCDO[]pCDOs
    holds handles of all cdo objects
  - StringpsSubReportName
    ## NOT FOR USE WITH MAINREPORT ## name of subreport (if main report, it is empty)
  - HandlephoExportObject
    ## NOT FOR USE WITH SUBREPORTS ##
  - HandlephoPreviewObject
  - Handle[]phoSubReports
    holds name and handle of all subreport objects
  - BooleanpbSubReportsLoaded
  - IntegerpiPrinterCopies
    Printer specific properties
  - IntegerpiPrinterStartPage
  - IntegerpiPrinterEndPage
    we treat zero as "to end of report"
  - BooleanpbPrinterCollate
  - BooleanpbPrinterPrompt
  - BooleanpbExportPrompt
- HandleDatabaseObject()
  -------------------- Database Functions Returns handle to database object
  - IntegerhoDatabase
  - VariantvDatabase
  - BooleanbAttached
- LoadDatabaseTables(Handle hoDatabaseTables)
  Creates all table objects
  - VariantvComDatabaseTable
  - IntegerhoDatabaseTable
  - IntegeriTableItem
  - IntegeriTableCount
  - BooleanbAttached
  - Integer[]hoTables
- HandleDatabaseTablesObject()
  Returns handle to database collection comautomation object. Creates connection if connection does not already exist. This is used privately to fill the table array which is accessed publicly via get TableObjects. We could destroy phoDatatables if we wanted but we are not currently doing so.
  - BooleanbAttached
  - IntegerhoDatabaseTables
  - IntegerhoDatabase
  - VariantvComDatabaseTables
- Handle[]TableObjects()
  Returns an array of tables in report
  - IntegerhoDatabaseTables
  - Integer[]hoTables
- HandleGetTableObjectByName(String sTable)
  Returns handle of table from name. Note:ComName returns the object name. This is the name given to a file (such as an alias name). ComLocation and ComConnectBufferString return the file the connection is made to.
  - StringsHoldName
  - IntegeriTableItem
  - IntegeriTableCount
  - Integer[]hoTables
- BooleanLocateDFFile(Handle hoDatabaseTable)
  Set the location of a dataflex datafile (.dat or .int) to the data directory
  - IntegeriPath
  - IntegeriNumPaths
  - BooleanbExists
  - StringDirSep
  - StringsTable
  - StringsLocation
- BooleanLocateDFFiles()
  ## NOT FOR USE WITH SUBREPORTS ## Locate all dataflex files for report and sub-report assign them to the data directory. If table cannot be relocated, process stops and false is returned; else return true.
  - Integer[]SubReportArray
  - IntegerhoSubReport
  - IntegeriReportItem
  - IntegeriReportCount
  - BooleanbOk
- BooleanLocateDFFilesForReport()
  Locate all dataflex files for this one report assign them to the data directory. If table cannot be relocated, process stops and false is returned; else return true
  - StringsTableType
  - IntegeriTableItem
  - IntegeriTableCount
  - IntegerhoDatabaseTable
  - Integer[]hoTables
  - BooleanbOK
- HandleCreateCDO(String sFileName)
  ## NOT FOR USE WITH SUBREPORTS ## Creates a CDO based on a TTX file.
  - IntegerhoCDO
  - tCRWCDO[]CRWCDOs
  - IntegeriCDOCount
  - IntegeriFieldType
  - IntegeriChannel
  - BooleanbOK
  - StringsLocation
  - StringsLine
  - StringsField
  - StringsFieldType
  - StringDirSep
- AppendCDOData(Handle hoCDO Variant[][] vCDOData)
  ## NOT FOR USE WITH SUBREPORTS ## Converts a safe array to the correct datatypes used by the CDO and attaches data to CDO. Example usage within OnInitializeReport: Send AppendCDOData of hoReport hoCDO vData
  - IntegeriCol
  - IntegeriMaxCol
  - IntegeriItem
  - IntegeriCount
  - IntegeriType
- AttachCDO(String sFileName Handle hoCDO)
  ## NOT FOR USE WITH SUBREPORTS ## Attaches an existing CDO to a report. This is usefull when a cdo is shared by multiple reports. Create the cdo once and attach it to each report.
  - IntegeriCDOCount
  - tCRWCDO[]CRWCDOs
- AssignCDODataSources(tCRWCDO[] CRWCDOs)
  ## NOT FOR USE WITH SUBREPORTS ## Attaches CDO data to report and subreport CDO objects
  - IntegerhoCDO
  - IntegerhoTable
  - IntegeriCDOItem
  - IntegeriCDOCount
  - StringsTable
  - StringDirSep
  - StringsPath
  - StringsType
- HandleFormulaFieldDefinitionsObject()
  End Database functions -------------------- Formula Functions Returns handle to report formula fields collection comautomation object. Creates connection if connection does not already exist. This is used privately by AssignFormula
  - VariantvFormulaFields
  - IntegerhoFormulaFieldDefinitions
  - BooleanbAttached
- AssignFormula(String sFormulaName String sValue)
  Sets report formula field to sValue
  - VariantvFormulaField
  - IntegerhoFormulaFieldDefinitions
  - IntegerhoFormulaFieldDefinition
  - BooleanbAttached
  - BooleanbDisplay
- LoadParams(handle hoParamFieldDefinitions)
  End Formula Functions -------------------- Parameter Functions Creates all Parameter objects
  - VariantvParameterFieldDefinition
  - IntegerhoParameterFieldDefinition
  - IntegeriParamItem
  - IntegeriParamCount
  - Integer[]hoParams
  - BooleanbAttached
- HandleParameterFieldDefinitionsObject()
  Returns handle to report parameter fields collection comautomation object. Creates connection if connection does not already exist. This is used privately to load the params object which is accessed publicly via Get ParamObjects. We could destroy phoParamFieldDefinitions when this is done, but we are currently not doing so.
  - VariantvParamFields
  - IntegerhoParamFieldDefinitions
  - BooleanbAttached
- Handle[]ParamObjects()
  Returns an array of Parameters in report
  - IntegerhoParamFieldDefinitions
  - Integer[]hoParams
- HandleGetParamObjectByName(String sParamName)
  Returns handle of Parameter object from name
  - StringsHoldName
  - IntegeriParamItem
  - IntegeriParamCount
  - Integer[]hoParams
- HandleSortFieldsObject()
  End Parameter Functions -------------------- Sort Functions Returns handle to report record sort fields collection comautomation object. Creates connection if connection does not already exist. This is used privately by the various sort methods (DeleteSortOrder, DeleteNthSortField and AppendSortField)
  - VariantvSortFields
  - IntegerhoSortFields
  - BooleanbAttached
- DeleteSortOrder()
  Deletes current record sort order
  - IntegerhoSortFields
  - IntegeriSortItem
  - IntegeriSortCount
- DeleteNthSortField(Integer iSortItem)
  Deletes current record sort order at position iSortItem
  - IntegerhoSortFields
- AppendSortField(String sTable String sField crSortDirection SortOrder)
  Adds table field to record sort order
  - VariantvField
  - VariantvFields
  - IntegerhoSortFields
  - IntegerhoDatabaseTable
  - IntegerhoTableFields
  - IntegerhoTableField
  - BooleanbOK
  - BooleanbAttached
  - StringsName
  - IntegeriField
  - IntegeriFieldCount
- AppendSortFormulaField(String sFormulaName crSortDirection SortOrder)
  Adds formula field to record sort order
  - VariantvField
  - IntegerhoSortFields
  - IntegerhoFormulaFieldDefinitions
  - BooleanbOK
  - BooleanbAttached
  - BooleanbDisplay
- LoadSubreports()
  End Sort Functions -------------------- Begin Subreport Functions ## NOT FOR USE WITH SUBREPORTS ## Loads all subreports into an array. Note: All objects are of a report are checked to check if it is a subreport. If it is a subreport, it is then created at the report level. All test objects are destroyed when this process is complete.
  - IntegerhoAreas
  - IntegerhoArea
  - IntegerhoSections
  - IntegerhoSection
  - IntegerhoReportObjs
  - IntegerhoSubReport
  - IntegerhoTemp
  - VariantvAreas
  - VariantvArea
  - VariantvSections
  - VariantvSection
  - VariantvReports
  - VariantvSubReport
  - VariantvReport
  - IntegeriArea
  - IntegeriSection
  - IntegeriSubReport
  - IntegeriKind
  - IntegeriCount
  - Integer[]SubReportArray
  - StringsName
  - BooleanbAttached
- Handle[]SubReportObjects()
  ## NOT FOR USE WITH SUBREPORTS ## Returns an array of subreports in report
  - Integer[]SubReportArray
- HandleGetSubReportObjectbyName(String sReportName)
  ## NOT FOR USE WITH SUBREPORTS ## Returns handle of subreport object comautomation object. Creates connection if connection does not already exist
  - IntegeriReportItem
  - IntegeriReportCount
  - StringsHoldName
  - Integer[]SubReportArray
- HandleExportObject()
  End Subreport Functions -------------------- Begin Output Funtions ## NOT FOR USE WITH SUBREPORTS ## Creates export object if it doesn't exist
  - IntegerhoExport
  - IntegerhcExportObject
  - VariantvExport
  - BooleanbAttached
- StringPreviewerName()
  - IntegerhoPreviewerParent
  - StringsPreviewerName
- HandlePreviewObject()
  ## NOT FOR USE WITH SUBREPORTS ## Returns handle of preview object
  - IntegerhoPreview
  - IntegerhoMain
  - IntegerhoClientArea
  - IntegerhcPreviewObject
  - StringsTitle
  - StringsPreviewerName
  - BooleanbAttached
- AssignPreviewObject(Handle hoPreview)
  ## NOT FOR USE WITH SUBREPORTS ## Override the default preview object
- HandleActiveXReportViewerObject()
  ## NOT FOR USE WITH SUBREPORTS ## Return handle of activeX preview object.
  - IntegerhoPreview
- PrintReport()
  ## NOT FOR USE WITH SUBREPORTS ## Printer specific
  - IntegeriStartPage
  - IntegeriEndPage
  - IntegeriCopies
  - BooleanbCollate
  - BooleanbPrompt
- ExportReport()
  Export specific
  - BooleanbPrompt
cCrystal : cObject
Main crystal report class
- Construct_Object()
  - IntegerpeOutputDestination
    destination of report
  - StringpsReportName
    name of report to be run
  - BooleanpbAutoLocateDFFiles
    controls if dat or int files are automatically located.
  - BooleanpbCanceled
    Can be set true by the developer within the events to stop a report from running.
  - BooleanpbCancelIfError
    Determines if a report is canceled if an error occurs. This can changed as often as needed to handle any particular section of code. If you want to try to handle an error, set this false (and be careful).
  - HandlephcReportObject
    Handle of classes used. Can be used to change the class of the composite child reportobject class
  - HandlephcPreviewObject
  - HandlephcExportObject
  - IntegerDisplay_Error_State
    if set to false, Crystal errors will not be sent to the error object.
  - BooleanpbHasErrors
  - HandleOld_Error_Object_Id
  - integerError_Processing_State
  - HandlephoReportObject
    report com object.
- handleApplicationObject()
  returns handle of attached com applicaton object. This creates this as a global object which is assigned to ghoCrystalReportServer. It then does a com attach. If the attach fails, zero is returned indicating failure. This can be used to test if the crystal rdc com objects are installed.
  - BooleanbDisplay
  - BooleanbAttached
  - IntegerhoError
- HandleReportObject()
  Return handle to existing report
- OnInitializeReport(Handle hoReport)
  Intended to be used by developer
- OnPrintReport(Handle hoReport)
  Intended to be used by developer
- OnExportReport(Handle hoReport)
  Intended to be used by developer
- OnDisplayReport(Handle hoReport)
  Intended to be used by developer
- PrintReport(Handle hoReport)
  Can be sent by developer (and possible augmented) in more advanced situations
  - BooleanbCancel
- ExportReport(Handle hoReport)
  Can be sent by developer (and possible augmented) in more advanced situations
  - BooleanbCancel
- DisplayReport(Handle hoReport)
  Can be sent by developer (and possible augmented) in more advanced situations
  - BooleanbCancel
  - IntegerhoPreview
- BooleanOpenReport()
  Creates report object if it doesn't exist. Opens psReportName.
  - IntegerhoReport
  - IntegerhoWorkspace
  - IntegerhoSubReport
  - IntegerhcReportObject
  - IntegerhoApplicationObject
  - VariantvReport
  - BooleanbAttached
  - BooleanbExists
  - BooleanbOk
  - BooleanbCanceled
  - StringsReport
  - StringsReportPath
  - StringDirSep
  - IntegeriPath
  - IntegeriNumPaths
  - IntegeriReportItem
  - IntegeriReportCount
  - tCRWCDO[]CRWCDOs
  - Integer[]SubReportArray
- OutputReport()
  - IntegerhoReport
  - IntegeriDestination
- DestroyReportObject()
  - BooleanbCanClose
- CloseReport()
- RunReport()
  - BooleanbOK
- Error_Report(integer ErrNum integer iErrLine string ErrMsg)
  when RunReport is called, errors are directed here.
  - IntegerhoError
  - BooleanbCancelOnError
- OnError(integer ErrNum integer iErrLine string ErrMsg)
  Event called by Error_Report. For augmentation.
- StringCrystalString(String sVal)
  - StringsNewVal
  - StringsHold
- StringCrystalInteger(Integer iVal)
- StringCrystalNumber(Number nVal)
  - IntegeriDecimalSeparator
  - StringsFormattedNumber
- StringCrystalDate(DateTime dtVal)
- Run_Report()
  compatibility methods
- StringReport_Name()
  Get / sets report name
- Set(String sReportName)
- IntegerOutput_Destination()
  Gets / Sets report output destination. Will return output device mode of report view if none specified.
- Set(Integer DevMode)

Module	Line
OrderPrecompile.pkg	6

Module

Line

OrderPrecompile.pkg

Module cCrystal.pkg

References (1):

Field References (0):