Overview of the Report Designer Object Model
Please review the following comments regarding object naming conflicts.
Object Naming Conflicts
If your project includes other libraries that contain objects named identical to those found in the Crystal Report Engine Object Library, you will encounter conflicts unless you reference the objects using a prefix. For example, if you have included the DAO Library with the Crystal Report Engine Object Library in your project, both libraries include a Database Object. In order to avoid conflicts, you must prefix the objects as follows:
CRAXDRT.Database
for the Crystal Report Engine Object Library, or
DAO.Database
for the DAO Library.
NOTE: You must always prefix when referencing the Font Object. Visual Basic includes a VB Font Object that is always included when creating a project, so conflicts will always occur unless the object is properly referenced. For example, CRPEAuto.Font.
Objects and Collections
The following Objects and Collections, listed alphabetically, are discussed in this section. Properties, Methods and Events are listed under the appropriate Object or Collection.
A...D, Page 12
E...O, Page 14
P...R, Page 15
S...Z, Page 17
A...D
Application Object, Page 18
¾Application Object Methods, Page 18
¾CanClose Method (Application Object), Page 18
¾LogOffServer Method (Application Object), Page 19
¾LogOnServer Method (Application Object), Page 20
¾OpenReport Method (Application Object), Page 21
¾SetMatchLogOnInfo Method (Application Object), Page 21
¾SetMorePrintEngineErrorMessages Method (Application Object), Page 21
Report Designer Component Object Model |
12 |
Area Object, Page 22
¾Area Object Properties, Page 22 Areas Collection, Page 24
¾Areas Collection Properties, Page 24 BlobFieldObject Object, Page 25
¾BlobFieldObject Object Properties, Page 25 BoxObject Object, Page 27
¾BoxObject Object Properties, Page 27 CrossTabObject Object, Page 29
¾CrossTabObject Object Properties, Page 29 Database Object, Page 30
¾Database Object Properties, Page 30
¾Database Object Methods, Page 31
¾LogOffServer Method (Database Object), Page 31
¾LogOnServer Method (Database Object), Page 32
¾SetDataSource Method (Database Object), Page 33
¾Verify Method (Database Object), Page 33 DatabaseFieldDefinition Object, Page 33
¾DatabaseFieldDefinition Object Properties, Page 34 DatabaseFieldDefinitions Collection, Page 36
¾DatabaseFieldDefinitions Collection Properties, Page 36 DatabaseTable Object, Page 36
¾DatabaseTable Object Properties, Page 36
¾DatabaseTable Object Methods, Page 37
¾SetDataSource Method (DatabaseTable Object), Page 37
¾SetLogOnInfo Method (DatabaseTable Object), Page 38
¾SetPrivateData Method (Database Table Object), Page 38
¾SetSessionInfo Method (Database Table Object), Page 39
¾TestConnectivity Method (Database Table Object), Page 40 DatabaseTables Collection, Page 40
¾DatabaseTables Collection Properties, Page 40
Report Designer Component Object Model |
13 |
E...O
ExportOptions Object, Page 41
¾ExportOptions Object Properties, Page 41
¾ExportOptions Object Methods, Page 45
¾PromptForExportOptions Method (ExportOptions Object), Page 45
¾Reset Method (ExportOptions Object), Page 45
¾ExportOptions Object Properties, Page 41
¾ExportOptions Object Methods, Page 45
¾PromptForExportOptions Method (ExportOptions Object), Page 45
¾Reset Method (ExportOptions Object), Page 45
FieldObject Object, Page 45
¾FieldObject Object Properties, Page 45 FormattingInfo Object, Page 50
¾FormattingInfo Object Properties, Page 50 FormulaFieldDefinition Object, Page 50
¾FormulaFieldDefinition Object Properties, Page 51
¾FormulaFieldDefinition Object Methods, Page 53
¾Check Method (FormulaFieldObject), Page 53 FormulaFieldDefinitions Collection, Page 53
¾FormulaFieldDefinitions Collection Properties, Page 53 GraphObject Object, Page 54
¾GraphObject Object Properties, Page 54 GroupNameFieldDefinition Object, Page 64
¾GroupNameFieldDefinition Object Properties, Page 64 GroupNameFieldDefinitions Collection, Page 66
¾GroupNameFieldDefinitions Collection Properties, Page 66 LineObject Object, Page 67
¾LineObject Object Properties, Page 67
MapObject Object, Page 68
¾MapObject Object Properties, Page 68 OLEObject Object, Page 70
¾OLEObject Object Properties, Page 70
Report Designer Component Object Model |
14 |
P...R
Page Object, Page 72
¾Page Object Properties, Page 72
¾Page Object Methods, Page 72
¾RenderEPF Method (Page Object), Page 73
¾RenderHTML Method (Page Object), Page 73 PageEngine Object, Page 74
¾PageEngine Object Properties, Page 75
¾PageEngine Object Methods, Page 75
¾CreatePageGenerator Method (PageEngine Object), Page 75
¾RenderTotallerETF Method (PageEngine Object), Page 76
¾RenderTotallerHTML Method (PageEngine Object), Page 76 PageGenerator Object, Page 77
¾PageGenerator Object Properties, Page 78
¾PageGenerator Object Methods, Page 78
¾DrillOnGraph Method (PageGenerator Object), Page 79
¾DrillOnMap Method (PageGenerator Object), Page 79
¾DrillOnSubreport Method (PageGenerator Object), Page 79
¾GetPageNumberForGroup Method (PageGenerator Object), Page 80
¾RenderTotallerETF Method (PageGenerator Object), Page 80
¾RenderTotallerHTML Method (PageGenerator Object), Page 81
¾SearchForText Method (PageGenerator Object), Page 82 Pages Collection, Page 83
¾Pages Collection Properties, Page 83 ParameterFieldDefinition Object, Page 83
¾ParameterFieldDefinition Object Properties, Page 84
¾ParameterFieldDefinition Object Methods, Page 87
¾AddCurrentRange Method (ParameterFieldDefinition Object), Page 88
¾AddCurrentValue Method (ParameterFieldDefinition Object), Page 88
¾AddDefaultValue Method (ParameterFieldDefinition Object), Page 89
¾ClearCurrentValueAndRange Method (ParameterFieldDefinition Object), Page 89
Report Designer Component Object Model |
15 |
¾DeleteNthDefaultValue Method (ParameterFieldDefinition Object), Page 89
¾GetNthCurrentRange Method (ParameterFieldDefinition Object), Page 90
¾GetNthCurrentValue Method (ParameterFieldDefinition Object), Page 90
¾GetNthDefaultValue Method (ParameterFieldDefinition Object), Page 91
¾SetNthDefaultValueMethod (ParameterFieldDefinition Object), Page 91 ParameterFieldDefinitions Collection, Page 92
¾ParameterFieldDefinitions Collection Properties, Page 92
PrintingStatus Object, Page 92
¾PrintingStatus Object Properties, Page 93 Report Object, Page 93
¾Report Object Properties, Page 93
¾Report Object Methods, Page 98
¾AddGroup Method (Report Object), Page 99
¾DiscardSavedData Method (Report Object), Page 100
¾Export Method (Report Object), Page 100
¾GetNextRows Method (Report Object), Page 101
¾OpenSubreport Method (Report Object), Page 101
¾PrintOut Method (Report Object), Page 102
¾ReadRecords Method (Report Object), Page 102
¾Save Method (Report Object), Page 102
¾SelectPrinter Method (Report Object), Page 103
¾SetDialogParentWindow Method (Report Object), Page 103
ReportObjects Collection, Page 103
¾ReportObjects Collection Properties, Page 104 RunningTotalFieldDefinition Object, Page 104
¾RunningTotalFieldDefinition Object Properties, Page 104 RunningTotalFieldDefinitions Collection, Page 106
¾RunningTotalFieldDefinitions Collection Properties, Page 106
Report Designer Component Object Model |
16 |
S...Z
Section Object, Page 107
¾Section Object Properties, Page 107
¾Section Object Event, Page 108
¾Format Event (Section Object), Page 108 Sections Collection, Page 110
¾Sections Collection Properties, Page 110 SortField Object, Page 110
¾SortField Object Properties, Page 111 SortFields Collection, Page 111
¾SortFields Collection Properties, Page 111
¾SortFields Collection Methods, Page 112
¾Add Method (SortFields Collection), Page 112
¾Delete Method (SortFields Collection), Page 112 SpecialVarFieldDefinition Object, Page 113
¾SpecialVarFieldDefinition Object Properties, Page 113 SQLExpressionFieldDefinition Object, Page 115
¾SQLExpressionFieldDefinition Object Properties, Page 115 SQLExpressionFieldDefinitions Collection, Page 117
¾SQLExpressionFieldDefinitions Collection Properties, Page 118 SubreportObject Object, Page 118
¾SubreportObject Object Properties, Page 118
¾SubreportObject Object Method, Page 120
¾OpenSubreport Method (Subreport Object), Page 120 SummaryFieldDefinition Object, Page 121
¾SummaryFieldDefinition Object Properties, Page 121
SummaryFieldDefinitions Collection, Page 123
¾SummaryFieldDefinitions Collection Properties, Page 124 TextObject Object, Page 124
¾TextObject Object Properties, Page 124
¾TextObject Object Method, Page 126
¾ SetText Method (TextObject Object), Page 126
Report Designer Component Object Model |
17 |