Class: cCrystalReport

Module location: cCrystal.pkg line 24 (view source)

Class Hierarchy:

DFCOMAUTOMATIONOBJECTcComAutomationObjectcCrystalReport

Mixins:

cCrystalIReport, cCrystalIReportEvent,

Class Definition

Properties

BooleanpbExportPrompt
BooleanpbPrinterCollate
BooleanpbPrinterPrompt
BooleanpbSubReportsLoaded
tCRWCDO[]pCDOs
holds handles of all cdo objects
HandlephoDatabase
available objects within the report class
HandlephoDatabaseTables
HandlephoExportObject
## NOT FOR USE WITH SUBREPORTS ##
HandlephoFormulaFieldDefinitions
HandlephoParamFieldDefinitions
Handle[]phoParams
holds handles of all paramterFieldDefinition objects
HandlephoPreviewObject
HandlephoSortFields
Handle[]phoSubReports
holds name and handle of all subreport objects
Handle[]phoTables
holds handles of all table objects
IntegerpiPrinterCopies
Printer specific properties
IntegerpiPrinterEndPage
we treat zero as "to end of report"
IntegerpiPrinterStartPage
StringpsReportLocation
Path to report file that was opened.
StringpsSubReportName
## NOT FOR USE WITH MAINREPORT ## name of subreport (if main report, it is empty)

Functions and Procedures

HandleActiveXReportViewerObject()
## NOT FOR USE WITH SUBREPORTS ## Return handle of activeX preview object.
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
AppendSortField(String sTable String sField crSortDirection SortOrder)
Adds table field to record sort order
AppendSortFormulaField(String sFormulaName crSortDirection SortOrder)
Adds formula field to record sort order
AssignCDODataSources(tCRWCDO[] CRWCDOs)
## NOT FOR USE WITH SUBREPORTS ## Attaches CDO data to report and subreport CDO objects
AssignFormula(String sFormulaName String sValue)
Sets report formula field to sValue
AssignPreviewObject(Handle hoPreview)
## NOT FOR USE WITH SUBREPORTS ## Override the default preview object
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.
Construct_Object()
Inherited from cComAutomationObject
HandleCreateCDO(String sFileName)
## NOT FOR USE WITH SUBREPORTS ## Creates a CDO based on a TTX file.
HandleDatabaseObject()
-------------------- Database Functions Returns handle to database object
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.
DeleteNthSortField(Integer iSortItem)
Deletes current record sort order at position iSortItem
DeleteSortOrder()
Deletes current record sort order
HandleExportObject()
End Subreport Functions -------------------- Begin Output Funtions ## NOT FOR USE WITH SUBREPORTS ## Creates export object if it doesn't exist
ExportReport()
Export specific
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
HandleGetParamObjectByName(String sParamName)
Returns handle of Parameter object from name
HandleGetSubReportObjectbyName(String sReportName)
## NOT FOR USE WITH SUBREPORTS ## Returns handle of subreport object comautomation object. Creates connection if connection does not already exist
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.
LoadDatabaseTables(Handle hoDatabaseTables)
Creates all table objects
LoadParams(handle hoParamFieldDefinitions)
End Formula Functions -------------------- Parameter Functions Creates all Parameter objects
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.
BooleanLocateDFFile(Handle hoDatabaseTable)
Set the location of a dataflex datafile (.dat or .int) to the data directory
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.
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
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.
Handle[]ParamObjects()
Returns an array of Parameters in report
StringPreviewerName()
HandlePreviewObject()
## NOT FOR USE WITH SUBREPORTS ## Returns handle of preview object
PrintReport()
## NOT FOR USE WITH SUBREPORTS ## Printer specific
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)
Handle[]SubReportObjects()
## NOT FOR USE WITH SUBREPORTS ## Returns an array of subreports in report
Handle[]TableObjects()
Returns an array of tables in report