CrystalDecisions.CrystalReports.Engine命名空间下包含如表6.1所示的类。这些类都拥有各自的成员,通过它们,使开发人员能够充分控制报表的结构与内容。
表6.1 CrystalDecisions.CrystalReports.Engine命名空间下包含的类
类
说明
Area
表示报表中的区域。区域是报表中的一组相似的节,这些节具有相同的特性
AreaForma
使您可以检索信息和为报表中的指定区域设置选项
Areas
包含报表中的每个区域的 Area对象
BlobFieldObject
表示报表上的 Blob 字段对象。该类使您可以检索表示特定字段对象类型的对象,还允许您设置从 ReportObject类继承的一般格式选项
BooleanFieldFormat
使您可以获取和设置布尔值字段的布尔值输出类型
Border
使您可以获取和设置报表中报表对象的边框选项
BoxObject
表示已绘制在报表上的框
ChartObject
表示报表上的图表对象
CommonFieldFormat
使您可以设置为报表中的所有字段所共用的格式选项
CrossTabObject
表示报表上的交叉表对象
Database
提供属性,以获取有关报表访问的数据库的信息
DatabaseFieldDefinition
表示报表中使用的数据库字段,并提供用于获取报表中的数据库字段信息的属性
DatabaseFieldDefinitions
包含报表中的每个数据库字段的 DatabaseFieldDefinition对象
DataDefinition
包含所有与数据操作有关的信息(数据操作依据报表中的数据源)
DateFieldFormat
使您可以获取和设置报表中日期字段的日期格式选项
DateTimeFieldFormat
使您可以获取和设置报表中日期时间字段的日期和时间格式选项
DateTimeGroupOptions
使您可以获取和设置报表中日期时间组的日期和时间选项
DrawingObject
为各种绘图对象提供一般属性的基类
FieldDefinition
为各种字段定义对象提供一般属性的基类
FieldFormat
使您可以获取各种类型的字段格式对象,以获取和设置该字段的格式选项
FieldHeadingObject
表示报表中的字段标题对象。该对象提供属性和方法,以检索信息和为报表中的字段标题对象设置选项
FieldObject
表示报表上的“字段”对象。该类使您可以检索表示特定种类和类型的字段对象的对象,还允许您设置从 ReportObject类继承的一般格式选项。
FormulaFieldDefinition
提供属性和方法,以检索信息和设置报表中任何命名公式字段的选项
FormulaFieldDefinitions
包含报表中的每个公式字段的FormulaFieldDefinition对象
GraphicObject
为各种图形对象提供一般属性的基类
Group
提供属性,以检索组所依据的特定字段定义对象以及用于设置组的条件的 GroupOptions对象
GroupNameFieldDefinition
提供属性以检索报表中组名字段的信息
GroupNameFieldDefinitions
包含报表中的每个组名字段的GroupNameFieldDefinition 对象
GroupOptions
为各种组选项对象提供一般属性的基类
Groups
包含报表中的每个组的 Group对象
LineObject
表示报表上绘制的线条对象。该类使您可以检索信息和设置从 DrawingObject类继承的一般格式选项
MapObject
表示报表上的地图对象
NumericFieldFormat
使您可以获取和设置报表中任何数字字段的数值格式选项
ObjectFormat
使您可以获取或设置影响报表中对象的物理行为的格式选项
OlapGridObject
代表报表上的 OLAP 网格对象。该类使您可以检索信息和设置从 ReportObject类继承的一般格式选项。
ParameterFieldDefinition
表示报表中的参数字段。该对象提供属性和方法,以检索信息和设置报表中的参数字段的选项
ParameterFieldDefinitions
包含报表中的每个参数字段的 ParameterFieldDefinition对象
PictureObject
表示报表上的图片对象
PrintOptions
提供用于设置报表打印选项的属性和方法
ReportDefinition
使您可以检索报表中的所有Areas、ReportObjects和Sections
ReportDocument
表示一个报表,并且包含定义、格式化、加载、导出和打印该报表的属性和方法
ReportObject
为各种报表对象提供一般属性的基类
ReportObjects
包含报表中的每个报表对象的 ReportObject对象
ReportOptions
使您可以获取和设置报表中的与数据有关的报表选项
RunningTotalFieldDefinition
表示报表中使用的运行总和字段。该类提供属性以获取报表中的运行总和字段的信息
RunningTotalFieldDefinitions
包含报表中的每个运行总计字段的 RunningTotalFieldDefinition对象
Section
报表区域至少包含一个节。该类包括用于访问有关报表节的信息的属性
SectionFormat
使您可以获取和设置节的格式选项
Sections
包含报表中的每个节的 Section对象
SortField
表示记录排序字段或组排序字段。该类提供属性以获取和设置报表中的排序字段的信息
SortFields
包含报表中的每个排序字段的 SortField对象。
SpecialVarFieldDefinition
提供属性以检索报表中的特殊字段的信息
SQLExpressionFieldDefinition
提供属性,以检索报表中的 SQL 表达式字段的信息
SQLExpressionFieldDefinitions
包含报表中的每个 SQL 表达式字段的 SQLExpressionFieldDefinition对象
SubreportObject
表示放在报表中的子报表
Subreports
包含报表中的每个子报表的 ReportDocument对象
SummaryFieldDefinition
表示报表中使用的摘要字段。该类提供用于获取报表中的摘要字段信息的属性
SummaryFieldDefinitions
包含报表中的每个摘要的 SummaryFieldDefinition对象
SummaryInfo
使您可以获取和设置摘要报表信息
Table
表示报表所访问的数据库表。该类提供属性和方法以获取表信息和设置表的登录信息
TableLink
使您可以检索有关数据库表链接的信息
TableLinks
包含报表中的每个表链接的 TableLink对象
Tables
包含报表中的每个表的 Table对象
TextObject
表示报表中的文本对象。该对象提供属性和方法,以检索信息和设置报表中的文本对象选项
TimeFieldFormat
使您可以获取和设置报表中任何时间字段的时间格式选
TopBottomNSortField
使您可以获取和设置 TopN 和 BottomN 排序字段的选项
当采用Crystal Reports Engine对象模型开发报表时,最常用的类就是ReportDocument类,该类被用来代表报表本身并且内含所有用来定义、载入、导出、格式化与打印报表的属性、方法与事件。
ReportDocument类常用公共属性及说明如表6.2所示。
表6.2 ReportDocument类常用公共属性及说明
属性
说明
Database
获取Database 对象
DataDefinition
获取DataDefinition 对象
DataSourceConnections
包含报表中所有表连接信息的IConnectionInfo 对象的集合。不包括子报表
EnterpriseSession
当RAS服务器由BusinessObjects Enterprise管理时,获取或设置对EnterpriseSession对象的引用
ExportOptions
获取ExportOptions类实例
FileName
指定报表文件的名称。如果指定协议或盘符,则假定使用默认的 "ras://"
FilePath
指定不带协议前缀的报表文件的名称
HasSavedData
获取报表是否有保存在内存中的数据
IsLoaded
获取该报表是否已使用 Load 方法加载
sSubreport
获取该报表是否是子报表
Name
获取报表的名称。对于主报表,该报表名称为空
ParameterFields
获取参数字段
PrintOptions
获取 PrintOptions 对象
RecordSelectionFormula
获取或设置记录选定公式
ReportAppServer
获取或设置报表应用程序服务器(也称为 RAS 服务器)的名称
ReportClientDocument
ReportClientDocument 类是进入基础 Report Application Server API 的入口点。如果ReportDocument.ReportAppServer 未指向 Report Application Server,则此属性将抛出异常
ReportDefinition
获取 ReportDefinition对象
ReportOptions
获取ReportOptions对象
Subreports
子报表。获取Subreports对象
SummaryInfo
获取SummaryInfo对象
ReportDocument类常用公共方法及说明如表6.3所示。
表6.3 ReportDocument类常用公共方法及说明
方法
说明
Close
关闭报表
EnableEventLog
启用打印引擎的事件日志。默认情况下该日志未启用
Export
将报表导出到在 ExportOptions对象内指定的格式和目标
ExportToDisk
将报表以指定格式导出到文件中
ExportToHttpResponse
将报表以指定格式导出到响应对象中
ExportToStream
将报表以指定格式导出到流中
GetConcurrentUsage
返回打开的并行作业个数,允许开发人员在应用程序中生成许可监视
Load
加载一个新报表。如果已加载了一个报表,则关闭它并打开一个新报表
OpenSubreport
打开报表中包含的子报表并返回与命名子报表对应的 ReportDocument对象
PrintToPrinter
使用 PrintOptions.PrinterName 属性将报表的指定页输出到选定的打印机上。如果未选择打印机,则将使用报表中指定的默认打印机
Refresh
删除保存的数据。这将导致随后查看报表时载入新数据
SaveAs
将报表保存到指定的文件中
SetCssClass
为各种节和报表对象设置级联式样式表 (CSS)
SetDatabaseLogon
利用用户名和密码设置数据库登录信息
SetDataSource
将 Object 传递给报表引擎
VerifyDatabase
检查数据库连接对于 ReportDocument 对象加载的报表是否是活动的