CrystalDecisions.CrystalReports.Engine

Represents an area in a report. An area is a group of like sections in the report that all share the same characteristics.

Gets the AreaFormat object.

Gets the kind of area or section.

Gets the area name.

Gets a collection of all the sections in the area.

Allows you to retrieve information and set options for a specified area in a report.

Gets or sets hide for drill down option.

Gets or sets the keep area together option.

Gets or sets the new page after option.

Gets or sets the new page before option.

Gets or sets the print at bottom of page option.

Gets or sets the reset page number after option.

Gets or sets the area visibility.

Contains the Area objects for every area in the report.

Gets the number of Area objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the Areas class.

Gets the object at the specified index. In C#, this property is the indexer for the Areas class.

Represents a blob field object on the report. This class allows you to retrieve the objects representing the specific kind of field object and also allows you to set generic format options inherited from the ReportObject class.

Gets the FieldDefinition object.

Allows you to get and set the Boolean output type for Boolean fields.

Gets or sets the Boolean output type.

Allows you to get and set border options for report objects in a report.

Gets or sets the background color of the object.

Gets or sets the border color of the object.

Gets or sets the line style for the bottom line of the object.

Gets or sets the border drop shadow option.

Gets or sets the line style for the left line of the object.

Gets or sets the line style for the right line of the object.

Gets or sets the line style for the top line of the object.

Represents a box that has been drawn on the report.

Gets or sets the fill color of the object.

Represents a chart object on the report.

Allows you to set format options common to all fields in a report.

Gets or sets the suppress if duplicate option.

Gets or sets the use system defaults formatting option.

Represents a cross-tab object on the report.

Provides properties to get information about the database accessed by a report.

Gets the TableLinks collection.

Gets the Tables collection.

Represents a database field used in the report and provides properties for getting information on database fields in the report.

Gets the name of the parent table.

Contains the DatabaseFieldDefinition objects for every database field in the report.

Gets the number of DatabaseFieldDefinition objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the DatabaseFieldDefinitions class.

Gets the object at the specified index. In C#, this property is the indexer for the DatabaseFieldDefinitions class.

Contains all the information relating to data manipulation based on the data source in a report.

Gets the FormulaFieldDefinitions collection.

Gets the GroupNameFieldDefinitions collection.

Gets the Groups collection.

Gets or sets the group selection formula.

Gets the ParameterFieldDefinitions collection.

Gets or sets the record selection formula.

Gets the RunningTotalFieldDefinitions collection.

Gets the SortFields collection.

Gets the SQLExpressionFieldDefinitions collection.

Gets the SummaryFieldDefinitions collection.

Allows you to get and set date format options for a date field in a report.

Gets or sets the day format.

Gets or sets the month format.

Gets or sets the year format.

Allows you to get and set date and time format options for a date-time field in a report.

Gets the DateFieldFormat object.

Gets or sets the date time separator.

Gets the TimeFieldFormat object.

Allows you to get and set date and time options for a date-time group in a report.

Gets or sets the numeric value for the group condition.

Gets or sets the enumerated value for the date time condition.

Base class providing generic properties for various kinds of drawing objects.

Gets or sets the object's bottom coordinate, in twips.

Gets or sets the extend to bottom of section option.

Gets the name of the section at the bottom of the object.

Gets or sets the line color of the object.

Gets or sets the line style for the object.

Gets or sets the thickness of the line in twips.

Gets or sets the object's right coordinate, in twips.

Base class providing generic properties for various kinds of field definition objects.

Gets the field definition unique formula name in Crystal Report formula syntax.

Gets the kind of field.

Gets the object's name.

Gets the number of bytes required to store the field data in memory.

Obsolete. Gets the number of times a field is used in a report.

Gets the type of field value.

Allows you to get various types of field format objects in order to get and set the format options for that field.

Gets the BooleanFieldFormat object.

Gets the CommonFieldFormat object.

Gets the DateFieldFormat object.

Gets the DateTimeFieldFormat object.

Gets the NumericFieldFormat object.

Gets the TimeFieldFormat object.

Represents a field-heading object found in a report. This object provides properties and methods for retrieving information and setting options for a field-heading object in a report.

Gets the name of the field object that this heading represents.

Represents a Field object on a report. This class allows you to retrieve the objects representing the specific kind and type of field object and also allows you to set generic format options inherited from the ReportObject class.

Applies changes made to the System.Drawing.Font object.

Contains the font settings for the FieldObject.

Gets or sets the color of the object.

Gets the FieldDefinition object. Use the FieldDefinition object to get and set format information specific to the kind of field.

Gets the FieldFormat object.

Gets the Font object.

Provides properties and methods for retrieving information and setting options for any named formula field in a report.

Checks the formula. If there is a syntax error it returns an error string and false.

If there is a syntax error then errString contains the error, otherwise errString is empty. A Boolean value, indicating if the formula syntax is correct.

Gets or sets the text of the formula.

Contains the FormulaFieldDefinition objects for every formula field in the report.

Gets the number of FormulaFieldDefinition objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the FormulaFieldDefinition class.

Gets the object at the specified index. In C#, this property is the indexer for the FormulaFieldDefinition class.

Base class providing generic properties for various kinds of graphic objects.

Provides properties for retrieving the specific field definition object the group is based on as well as the GroupOptions object used to set the group's condition.

Gets the FieldDefinition object.

Gets the GroupOptions object.

Provides properties for retrieving information on a group name field found in a report.

Gets the field definition unique formula name in Crystal Report formula syntax.

Gets the Group object.

Gets the group name field name.

Gets the kind of field.

Gets the object's name.

Gets the number of bytes required to store the field data in memory.

Gets the type of field value.

Contains the GroupNameFieldDefinition objects for every group name field in the report.

Gets the number of GroupNameFieldDefinition objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the GroupNameFieldDefinition class.

Gets the object at the specified index. In C#, this property is the indexer for the GroupNameFieldDefinition class.

Base class providing generic properties for various kinds of group options objects.

Gets or sets the numeric value for the group condition.

Contains the Group objects for every group in the report.

Gets the number of Group objects in the collection.

Gets the object at the specified index. In C#, this property is the indexer for the Group class.

Represents a line object drawn on the report. This class allows you to retrieve information and set generic format options inherited from the DrawingObject class.

Represents a geographic map object on the report.

Allows you to get and set the numeric format options for any number field in a report.

Gets or sets the currency symbol type.

Gets or sets the number of decimal places.

Gets or sets the option to use a leading zero for decimal values.

Gets or sets the negative format type.

Gets or sets the rounding format type.

Allows you to get or set formatting options that affect the physical behavior of objects in a report.

Gets or sets the name of the cascading style sheet (CSS) for the object.

Gets or sets the option for the object to grow to accommodate field input.

Gets or sets the close border on page break option.

Gets or sets the keep object together option.

Gets or sets the object's visibility.

Gets or sets the alignment type.

Represents an OLAP grid object on the report. This class allows you to retrieve information and set generic format options inherited from the ReportObject class.

Represents a parameter field in the report. This object provides properties and methods for retrieving information and setting options for a parameter field in a report.

Applies the current values to the specified parameter field of a report.

Contains the current values set for the parameter.

Applies values to the group of default values for a specified parameter in a report.

Contains the default values set for the parameter.

Applies the maximum and minimum values to a specified parameter in a report.

Indicates the minimum allowable value for the parameter. Indicates the maximum allowable value for the parameter.

Tests to see if the parameter is linked. A linked parameter is created when a main report is linked to a subreport.

Gets the current values through the ParameterValues object.

Gets the default values through the ParameterValues object.

Gets the method in which the default values are sorted.

Gets or sets the order in which the default values are sorted.

Gets or sets whether or not the parameter field contains discrete values, range values, or both.

Gets or sets edit mask that restricts what may be entered for string parameters.

Gets or sets if the default values can be edited.

Gets or sets the allow multiple values option.

Gets the allow null value option for stored procedure parameters.

Gets whether the parameter has a current value.

Gets the maximum value.

Gets the minimum value.

Gets the name of the parameter field.

Gets the property that describes how the parameter is used within the report.

Gets the parameter type.

Gets the type of the parameter value.

Gets or sets the parameter field prompting string.

Gets the report name the parameter field is in. If it is a main report, the report name is empty.

Contains the ParameterFieldDefinition objects for every parameter field in the report.

Gets the number of ParameterFieldDefinition objects in the collection.

Gets the object with the specified parameter name and report name. In C#, this property is the indexer for the ParameterFieldDefinition class.

Gets the object with the specified name. In C#, this property is the indexer for the ParameterFieldDefinition class.

Gets the object at the specified index. In C#, this property is the indexer for the ParameterFieldDefinition class.

Represents a picture object on the report.

Provides properties and methods for setting the options for printing a report.

Applies the page margin settings to the report.

Contains the page margins settings for the report.

Copies the values of PrinterSettings and PageSettings into this PrintOptions.

The PrinterSettings to use. The PageSettings to use.

Copies the values of this PrintOptions into PrinterSettings and PageSettings.

The PrinterSettings to use. The PageSettings to use.

Gets or sets the current printer paper source.

Gets the height of the page's content.

Gets the width of the page's content.

Gets the reports' page margins. Use the ApplyPageMargins method to apply the changes.

Gets or sets the current printer paper orientation.

Gets or sets the current printer paper size.

Gets or sets the current printer paper source.

Gets or sets the current printer duplex option.

Gets or sets the printer name used by the report.

Allows you to retrieve all of the ReportObjects, and Sections in a report.

Gets the Areas collection.

Gets the ReportObjects collection.

Gets the Sections collection.

Represents a report and contains properties and methods to define, format, load, export, and print the report.

Closes the report.

Enables the event log for the print engine. By default the log is not enabled.

Indicates whether to enable the event log.

Exports a report to a format and destination specified within the ExportOptions Object.

The format and destination to export the report.

Exports a report to a file in the specified format.

The format type to export the report. The file name to export the report.

Exports a report to the response object in the specified format.

The options for the export of the report. The response object of the page. Indicates whether or not the report will be exported as an attachment of the response. The file name to export the report.

Exports a report to the response object in the specified format.

The format type to export the report. The response object of the page. Indicates whether or not the report will be exported as an attachment of the response. The file name to export the report.

Exports a report to a stream in the specified format.

The format type to export the report. A stream that contains the exported report as a sequence of bytes.

Returns the number of concurrent jobs opened allowing developers to build license monitoring into their applications.

The number of concurrent jobs opened.

Loads a new report and sets the OpenReportMethod enumeration. If a report is already loaded, then it is closed and a new one is opened.

Indicates the path and filename of the report. Indicates if the report is to be opened as a temporary copy or by default.

Loads a new report. If a report is already loaded, then it is closed and a new one is opened.

Indicates the path and filename of the report.

Opens a subreport contained in the report and returns a ReportDocument object corresponding to the named subreport.

Returns a separate ReportDocument that represents the subreport.

Prints the specified pages of the report to the printer selected using the PrintOptions.PrinterName property. If no printer is selected, the default printer specified in the report will be used.

Indicates the number of copies to print. Indicates whether to collate the pages. Indicates the first page to print. Indicates the last page to print.

Removes saved data. This causes fresh data to be loaded when the report is subsequently viewed.

Saves the report and its data into the specified file.

Indicates the path and filename of the report. Indicates whether or not the report data will be saved.

Saves the report into the specified file.

Indicates the path and filename of the report.

Sets the cascading style sheet (CSS) for various sections and report objects.

Indicates the section or sections of the report that the style class will apply to. For example, set the style for the whole report, or set the style for the Report Header section. The name of the style class as defined in the style sheet.

Sets the database logon information with a user name and password.

The user name. The password.

Sets the database logon information. This method sets the user name, the password, the server name and the database name.

The user name. The password. The server name. The database name.

Passes an Object to the report engine.

Represents a valid dataset object.

Passes an IDataReader to the report engine.

Represents a valid IDataReader object.

Passes an IDataReader to the report engine.

Represents a valid DataTable object.

Passes a Recordset or Dataset to the report engine.

Represents a valid dataset object.

Sets the current value of a parameter field at the specified index. The value can be a primitive, ParameterValue, an array of either type, or a ParameterValues collection.

The index of the parameter field. Represents a valid parameter value. It can be a primitive, ParameterValue, an array of either type, or a ParameterValues collection.

Sets the current value of a parameter field. The value can be a primitive, ParameterValue, an array of either type, or a ParameterValues collection.

The name of the parameter field. Represents a valid parameter value. It can be a primitive, ParameterValue, an array of either type, or a ParameterValues collection.

Sets the current value of a parameter field in a subreport. The value can be a primitive, ParameterValue, an array of either type, or a ParameterValues collection.

The name of the parameter field. Represents a valid parameter value. It can be a primitive, ParameterValue, an array of either type, or a ParameterValues collection. The name of the subreport to which the parameter field belong.

Checks whether the database connection is active for the report that is loaded by the ReportDocument object.

Gets the Database object.

Gets the DataDefinition object.

A collection of IConnectionInfo objects which contains connection info of all the tables in the report. This does not include the subreports.

Gets or sets the reference to the EnterpriseSession object when the RAS server is managed by BusinessObjects Enterprise.

Gets the ExportOptions class instance.

Specifies the name of the report file. If protocol or drive letter is specified, a "ras://" default is assumed.

Specifies the name of the report file without the protocol prefix.

Gets whether the report has data saved in memory.

Gets whether the report has been loaded using the Load method.

Gets whether the report is a subreport.

Gets the report name. For the main report, the report name is empty.

Gets the parameter fields.

Gets the PrintOptions object.

Gets or sets record selection formula.

Gets or sets the name of the Report Application Server (also know as the RAS Server).

The ReportClientDocument class is an entry point to the underlying Report Application Server API. If ReportDocument.ReportAppServer does not point to a Report Application Server, this property will throw an exception.

Gets the ReportDefinition object.

Gets the ReportOptions object.

Subreports. Gets the Subreports object.

Gets the SummaryInfo object.

Base class providing generic properties for various kinds of report objects.

Gets the Border object.

Gets or sets the object's height, in twips.

Gets kind of report object from the ReportObjectKind enum.

Gets or sets the object's upper left position, in twips.

Gets the object's name.

Gets the ObjectFormat object.

Gets or sets the object's upper top position, in twips.

Gets or sets the object's width, in twips.

Contains the ReportObject objects for every report object in the report.

Gets the number of ReportObject objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the ReportObject class.

Gets the object at the specified index. In C#, this property is the indexer for the ReportObject class.

Allows you to get and set the data related report options in a report.

Gets or sets the option to automatically save database data with a report.

Gets or sets the option to save a thumbnail picture of a report.

Gets or sets the option to save the data summaries you create with the report.

Gets or sets the option to use dummy data when viewing the report at design time.

Gets or sets the specific record or records that will become the initial data displayed in the CrystalReportPartsViewer.

Gets or sets the name of the report part that will be displayed in the CrystalReportPartsViewer by default.

Represents a running total field used in the report. This class provides properties for getting information on running total fields in the report.

Gets the evaluation condition object for this RunningTotalFieldDefinition.

Gets the Group object.

Gets the running total field name.

Gets the summary operation type.

Gets the operation parameter based on the SummaryOperation type.

Gets the reset condition object for this RunningTotalFieldDefinition.

Gets the secondary summarized field's FieldDefinition object.

Gets the main summarized field's FieldDefinition object.

Contains the RunningTotalFieldDefinition objects for every running total field in the report.

Gets the number of RunningTotalFieldDefinition objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the RunningTotalFieldDefinition class.

Gets the object at the specified index. In C#, this property is the indexer for the RunningTotalFieldDefinition class.

For internal use only.

Report areas contain at least one section. This class includes properties for accessing information regarding a section of a report.

Gets or sets the object's height, in twips.

Gets the kind of area or section.

Gets the section name.

Gets the ReportObjects collection.

Gets the SectionFormat object.

Allows you to get and set format options for a section.

Gets or sets the background color of the object.

Gets or sets the name of the cascading style sheet (CSS) for the object.

Gets or sets the option that indicates whether to keep the entire section on the same page if it is split into two pages.

Gets or sets the new page after options.

Gets or sets the new page before option.

Gets or sets the print at bottom of page option.

Gets or sets the reset page number after option.

Gets or sets the area visibility.

Gets or sets the option that indicates whether to suppress the current section if it is blank.

Gets or sets the underlay following section option.

Contains the Section objects for every section in the report.

Gets the number of Section objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the Section class.

Gets the object at the specified index. In C#, this property is the indexer for the Section class.

Represents a record or group sort field. This class provides properties to get and set information on sort fields in the report.

Gets or sets the sort field's FieldDefinition object.

Gets or sets the sort direction.

Gets the sort field type.

Contains the SortField objects for every sort field in the report.

Gets the number of SortField objects in the collection.

Gets the object at the specified index. In C#, this property is the indexer for the SortField class.

Provides properties for retrieving information on a special field found in a report.

Gets the type of special field.

Provides properties for retrieving information on a SQL expression field found in a report.

Gets the kind of field.

Gets the SQL expression text.

Contains the SQLExpressionFieldDefinition objects for every SQL expression field in the report.

Gets the number of SQLExpressionFieldDefinition objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the SQLExpressionFieldDefinition class.

Gets the object at the specified index. In C#, this property is the indexer for the SQLExpressionFieldDefinition class.

Represents a subreport placed in a report.

The OpenSubreport method opens a subreport contained in the report and returns a ReportDocument Object corresponding to the named subreport.

Indicates the name of the subreport to open. Returns a separate ReportDocument that represents the subreport.

Gets or sets the real-time subreport option.

Gets the name of the subreport.

Contains the ReportDocument objects for every subreport in the report.

Gets the object at the specified index. In C#, this property is the indexer for the SubreportObject class.

Gets the object with the specified name. In C#, this property is the indexer for the SubreportObject class.

Represents a summary field used in the report. This class provides properties for getting information on summary fields in the report.

Gets the Group object.

Gets the object's name.

Gets the summary operation type.

Gets the operation parameter based on the SummaryOperation type.

Gets the main summarized field's FieldDefinition object.

Gets the secondary summarized field's FieldDefinition object.

Contains the SummaryFieldDefinition objects for every summary in the report.

Gets the number of SummaryFieldDefinition objects in the collection.

Gets the object at the specified index. In C#, this property is the indexer for the SummaryFieldDefinition class.

Allows you to get and set summary report information.

Gets or sets the keywords in the report.

Gets or sets the report author.

Gets or sets the report comments.

Gets or sets the report subject.

Gets or sets the report title.

Represents a database table accessed by the report. This class provides properties and methods to get information about the table and set logon information for the table.

Updates changes to the TableLogOnInfo object returned through the Table.LogOnInfo property.

Contains the logon information.

Passes a Recordset or Dataset to the report engine.

Represents a valid dataset object.

Passes a IDataReader to the report engine.

Represents a valid IDataReader object.

Passes a DataTable to the report engine.

Represents a valid DataTable object.

Passes a Recordset or Dataset to the report engine.

Represents a valid dataset object.

Tests to see if a connection to the database can be established with the current information, and if the report can access the database table.

True if the database session, log on, and location information is correct. False if the connection fails or an error occurs.

Gets the DatabaseFieldDefinitions collection.

Gets or sets the location of the database table.

Gets the TableLogOnInfo object.

Gets the alias name for the database table used in the report.

Allows you to retrieve information on the database table links.

Gets reference to table link destination DatabaseFieldDefinitions collection.

Gets reference to the table link destination Table object.

Gets a summary of the linking used by the table.

Gets reference to table link source DatabaseFieldDefinitions collection.

Gets reference to the table link source Table object.

Contains the TableLink objects for every table link in the report.

Gets the number of TableLink objects in the collection.

Gets the object at the specified index. In C#, this property is the indexer for the TableLink class.

Contains the Table objects for every table in the report.

Gets the number of Table objects in the collection.

Gets the object with the specified name. In C#, this property is the indexer for the Table class.

Gets the object at the specified index. In C#, this property is the indexer for the Table class.

Represents a text object found in a report. This object provides properties and methods for retrieving information and setting options for a text object in a report.

Applies changes made to the System.Drawing.Font object.

Contains the font settings for the TextObject.

Gets or sets the color of the object.

Gets the Font object.

Gets or sets the text within the text object.

Allows you to get and set time format options for any time field in a report.

Gets or sets the AM/PM type.

Gets or sets the AM string.

Gets or sets the hour type.

Gets or sets the hour minute separator.

Gets or sets the minute type.

Gets or sets minute second separator.

Gets or sets the PM string.

Gets or sets the seconds type.

Gets or sets the time base.

Allows you to get and set options for the TopN and BottomN sort field.

Gets or sets the discard other groups option.

Gets or sets the group heading for the groups that are not in the TopBottomNSortFields specified in the report.

Gets or sets the number of groups to display in a top or bottom sort.

Gets the sort field type.