The C1Report type exposes the following members.

Methods

  Name Description
Public method AddScriptObject(String, Object)
Adds an object to the report's script context.
Public method AddScriptObject(String, Object, Boolean)
Adds an object to the report's script context.
Public method BeginInit
Signals the object that initialization is starting.
Public method Clear
Clears the current report.
Public method ClearGeneratedPages
Clears the pages and other info created during report generation. This method does not clear the report definition though.
Public method CopyFrom
Copies a report definition from another C1Report component.
Protected method Dispose
Releases the resources used by the component.
(Overrides Component..::..Dispose(Boolean).)
Public method EndInit
Signals the object that initialization is complete.
Public method Evaluate
Evaluates a VBScript expression in the current report context.
Public method Execute
Executes a VBScript statement in the current report context.
Public method GetPageCount
Gets the total number of pages in the generated report. Use this method rather than Count on the PageImages collection as accessing that property creates images for all pages at once and thus can exhaust system resources.
Public method GetPageImage
Gets a metafile representing the specified page. Use this method rather than the PageImages collection as accessing that property creates images for all pages at once and thus can exhaust system resources.
Public method GetPageImages
Enumerates page images (represented by metafiles) of the generated report. Using this method in a "foreach" loop allows to iterate over all pages of a large report without exhausting system resources. This approach is preferable to PageImages property that creates images for all pages and can consume a large amount of resources.
Public method GetReportInfo(String)
Gets a list of reports available in an XML report definition file.
Public method GetReportInfo(XmlDocument)
Gets a list of reports available in an XmlDocument.
Public method Static member GetReportList(Stream)
Gets a list of reports available in an XML report definition file.
Public method Static member GetReportList(String)
Gets a list of reports available in an XML report definition file.
Public method Static member GetReportList(XmlDocument)
Gets a list of reports available in an XmlDocument.
Public method Load(Stream, String)
Loads a report from an XML report definition in stream.
Public method Load(String, String)
Loads a report from an XML report definition file.
Public method Load(XmlDocument, String)
Loads a report from an XmlDocument.
Protected method OnAddOutlineEntry
Raises the AddOutlineEntry event.
Protected method OnEndPage
Raises the EndPage event.
Protected method OnEndReport
Raises the EndReport event.
Protected method OnEndSection
Raises the EndSection event.
Protected method OnInitializeParametersDialog
Raises the InitializeParametersDialog event.
Protected method OnNoReportData
Raises the NoData event.
Protected method OnPrintSection
Raises the PrintSection event.
Protected method OnReportError
Raises the ReportError event.
Protected method OnStartPage
Raises the StartPage event.
Protected method OnStartReport
Raises the StartReport event.
Protected method OnStartSection
Raises the StartSection event.
Public method ParseExpression
Parses a VBScript expression in the current report context.
Public method ParseStatement
Parses a VBScript statement in the current report context.
Public method Render
Renders the report into an internal collection of images.
Public method RenderToFile
Renders the report into a file.
Public method RenderToFilter
Renders the report into an ExportFilter object.
Public method RenderToStream(Stream, FileFormatEnum)
Renders the report into a Stream object.
Public method RenderToStream(Stream, FileFormatEnum, String, String)
Renders the report into an Html Stream.
Public method Save(String)
Saves the current report definition to a file.
Public method Save(XmlTextWriter)
Saves the current report definition to an XmlTextWriter object.
Public method Save(String, Boolean)
Saves the current report definition to a file.
Public method Save(XmlTextWriter, Boolean)
Saves the current report definition to an XmlTextWriter object.
Public method Save(Stream, Boolean, Boolean)
Saves the current report definition to a stream.
Public method Save(String, Boolean, Boolean)
Saves the current report definition to a file.
Public method Save(XmlTextWriter, Boolean, Boolean)
Saves the current report definition to an XmlTextWriter object.

Properties

  Name Description
Public property C1Document
Gets a C1PrintDocument object that represents content of the report.
Public property Cancel
Specifies whether to cancel generation of the current report.
Public property ColorizeHyperlinks
Gets or sets a value indicating whether hyperlinks in the report are colorized automatically.

The default is false (which is compatible with older versions of C1Report).
Public property DataSource
Gets a reference to the report's DataSource object.
Public property Document
Gets a PrintDocument object that can be used to render the report to a printer or into a print preview control.
Public property DoEvents
Specifies whether the control should handle Windows messages while rendering reports.
Public property EmfType
Gets or sets the type of metafiles created by the current report. The default is EmfOnly.
Public property ExposeScriptObjects
Specifies whether script objects added with the AddScriptObject(String, Object) method should be exposed to subreports.
Public property Fields
Gets the collection of Field objects in the report definition.
Public property Font
Gets or sets the default font for new fields.
Public property GeneratingComplete
If the current report is generating (see IsBusy), gets the approximate completion ratio, from 0 (0% complete) to 1 (100% complete). If the report is currently not generating, gets 1.
Public property Groups
Gets a collection with all the groups in the report.
Public property GrowShrinkMode
Gets or sets the method used to process CanGrow/CanShrink fields.
Public property IgnoreScriptErrors
Specifies whether the component should ignore script errors by default.
Public property IsBusy
Gets a value that determines whether a report is currently being generated.
Public property LabelOffset
Gets or sets the position of the first label on a partially used sheet.
Public property Layout
Gets a reference to the report's Layout object.
Public property MaxPages
Gets or sets the maximum number of pages allowed for a report.
Public property OnClose
Gets or sets the VBScript that is executed when the report finishes rendering.
Public property OnError
Gets or sets the VBScript that is executed when an error occurs.
Public property OnNoData
Gets or sets the VBScript that is executed when the report starts rendering and its source recordset is empty.
Public property OnOpen
Gets or sets the VBScript that is executed when the report starts rendering.
Public property OnPage
Gets or sets the VBScript that is executed when a new page is created.
Public property OutlineRootLevel
Gets or sets the starting outline level for the groups in this report.
Public property Page
Gets or sets the current page number.
Public property PageImages Obsolete.
Gets a list of Metafile objects that correspond to the pages in the report. Using this property on large reports is not recommended as it creates images for all pages at once and thus can exhaust system resources. Instead, use GetPageImages()()()(), GetPageImage(Int32) and GetPageCount()()()() methods.
Public property ParentReport
Gets the main report that contains this subreport (null for main reports).
Public property RecordsPerPage
Gets or sets the number of detail records to render per page or group.
Public property ReferenceDc
Public property ReferenceDpi
Public property ReportDefinition
Gets or sets an Xml string containing the complete report definition.
Public property ReportInfo
Gets or sets a ReportInfo object containing report metadata.
Public property ReportName
Gets or sets the name of the report (used with the Load method).
Public property Sections
Gets the collection of Section objects in the report definition.
Public property Tag
Gets or sets extra data needed by the calling program.
Public property UseGdiPlusTextRendering
Gets or sets a value indicating whether all text in the current report should be rendered using GDI+ text API.

The default value is false.
Public property UsePrinterResolution
Specifies whether the component should use the .NET printing support to obtain high-resolution graphics.

Events

  Name Description
Public event AddOutlineEntry
Fired before the control adds an outline entry to the report.
Public event EndPage
Fired when the control finishes rendering each page.
Public event EndReport
Fired when the control finishes rendering the report.
Public event EndSection
Fired when the control finishes rendering each Section.
Public event InitializeParametersDialog
Fired before the control displays the Report Parameters dialog.
Public event LongOperation
Occurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation to the user.
Public event NoData
Fired when the control starts rendering a report and the data source is empty.
Public event PrintSection
Fired before each Section is printed (after it has been formatted.)
Public event ReportError
Fired when an error occurs while rendering a report.
Public event StartPage
Fired when the control starts rendering each page.
Public event StartReport
Fired when the control starts rendering the report, before it opens the source recordset.
Public event StartSection
Fired before each Section is formatted.

See Also