Name | Description | |
---|---|---|
C1Report Constructor | Initializes a new instance of the C1Report component. |
The following tables list the members exposed by C1Report.
Name | Description | |
---|---|---|
C1Report Constructor | Initializes a new instance of the C1Report component. |
Name | Description | |
---|---|---|
ActualCreationDevice | Gets the actual measurement device which was used to generate the report. This device can differ from the one specified by CreationDevice, for example if CreationDevice was set to C1.C1Preview.MeasurementDeviceEnum.Printer but the current system has no printers installed. | |
ActualCreationPrinterName | Gets the name of the actual measurement printer which was used to generate the report. This can differ from the name specified by CreationPrinterName, for example if the report was rendered on a system with no such printer. | |
ActualRightToLeft | Gets the actual right-to-left value that is being used. The value is obtained using the following rules:
| |
AvailableHeight | Gets the height of the remaining area available for sections on the current page. This property can only be used while the report is being rendered (i.e. when IsBusy is true), at other times a value of -1 is returned. Note that if used in OnPrint/OnFormat scripts, this value does NOT yet account for the current section. | |
C1Document | Gets a C1.C1Preview.C1PrintDocument object that represents content of the report. Note that getting this property causes the report to render if it has not rendered yet. | |
Cancel | Specifies whether to cancel generation of the current report. | |
ColorizeHyperlinks | Gets or sets a value indicating whether hyperlinks in the report are colorized automatically.
The default is | |
CompatibilityOptions | Gets the CompatibilityOptions object which determines compatibility with previous versions of C1Report. | |
Container | (Inherited from System.ComponentModel.Component) | |
CreationDevice | Gets or sets the type of device that is used to provide reference graphics when generating the report. If this property is C1.C1Preview.MeasurementDeviceEnum.Printer (which is the default), CreationPrinterName specifies the printer. | |
CreationDpi | Gets or sets the resolution (DPI) used when generating the report. | |
CreationGraphics | Gets or sets the System.Drawing.Graphics object to use as reference when generating the report. This Graphics is used to calculate text sizes, measure RTF text, and so on. | |
CreationPrinterName | Gets or sets the name of the printer that is used to provide reference graphics when generating the report.
This property is only used if CreationDevice is set to C1.C1Preview.MeasurementDeviceEnum.Printer. Set this property to null to select the reference printer automatically. | |
DataSource | Gets a reference to the report's DataSource object. | |
DefaultRightToLeft | Gets or sets the value used as the default for the RightToLeft property. | |
Document | Gets a System.Drawing.Printing.PrintDocument object that can be used to render the report to a printer or into a print preview control. | |
DoEvents | Specifies whether the control should handle Windows messages while rendering reports. | |
EmfType | Gets or sets the type of metafiles created by the current report. The default is System.Drawing.Imaging.EmfType.EmfOnly. | |
ExposeScriptObjects | Specifies whether script objects added with the AddScriptObject(String,Object) method should be exposed to subreports. | |
Fields | Gets the collection of Field objects in the report definition. | |
Font | Gets or sets the default font for new fields. | |
FontProcessingOptions | Gets the FontProcessingOptions object which determines how font substitution and embedding are handled when the report generates. | |
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. | |
GlobalScripts | Gets or sets the global VBScript module. Functions and subroutines defined here (using the standard VBScript syntax) can be used in other scripts in the current report like standard VBScript functions. | |
Groups | Gets a collection with all the groups in the report. | |
GrowShrinkMode | Gets or sets the method used to process CanGrow/CanShrink fields. | |
IgnoreScriptErrors | Specifies whether the component should ignore script errors by default. | |
IsBusy | Gets a value that determines whether a report is currently being generated. | |
LabelOffset | Gets or sets the position of the first label on a partially used sheet. | |
Layout | Gets a reference to the report's Layout object. | |
MaxPages | Gets or sets the maximum number of pages allowed for a report. | |
OnClose | Gets or sets the VBScript that is executed when the report finishes rendering. | |
OnError | Gets or sets the VBScript that is executed when an error occurs. | |
OnNoData | Gets or sets the VBScript that is executed when the report starts rendering and its source recordset is empty. | |
OnOpen | Gets or sets the VBScript that is executed when the report starts rendering. | |
OnPage | Gets or sets the VBScript that is executed when a new page is created. | |
OutlineRootLevel | Gets or sets the starting outline level for the groups in this report. | |
Page | Gets or sets the current page number. | |
PageImages | Gets a list of System.Drawing.Imaging.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 and GetPageCount methods. | |
PageRenderingMode | Gets or sets a value specifying the page rendering mode to use when generating the report. Use PageRenderingMode.AsMetafiles for very large reports which run out of memory when using the default mode. | |
ParentReport | Gets the main report that contains this subreport (null for main reports). | |
RecordsPerPage | Gets or sets the number of detail records to render per page or group. | |
ReportDefinition | Gets or sets an Xml string containing the complete report definition. | |
ReportInfo | Gets or sets a ReportInfo object containing report metadata. | |
ReportName | Gets or sets the name of the report (used with the Load method). | |
RightToLeft | Gets or sets a value indicating whether the fields of the report should use right-to-left rules for rendering text.
If null (which is the default), the value of the static property DefaultRightToLeft is used. This value may be overridden by individual fields. | |
Sections | Gets the collection of Section objects in the report definition. | |
Site | (Inherited from System.ComponentModel.Component) | |
Tag | Gets or sets extra data needed by the calling program. | |
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. | |
UsePrinterResolution | Specifies whether the component should use the .NET printing support to obtain high-resolution graphics. |
Name | Description | |
---|---|---|
CanRaiseEvents | (Inherited from System.ComponentModel.Component) | |
DesignMode | (Inherited from System.ComponentModel.Component) | |
Events | (Inherited from System.ComponentModel.Component) |
Name | Description | |
---|---|---|
AddScriptObject | Overloaded. Adds an object to the report's script context. | |
BeginInit | Signals the object that initialization is starting. | |
Clear | Clears the current report. | |
ClearGeneratedPages | Clears the pages and other info created during report generation. This method does not clear the report definition though. | |
CopyFrom | Copies a report definition from another C1Report component. | |
CreateObjRef | (Inherited from System.MarshalByRefObject) | |
Dispose | Overloaded. Overridden. Releases the resources used by the component. | |
EndInit | Signals the object that initialization is complete. | |
Evaluate | Overloaded. Evaluates a VBScript expression in the current report context. | |
Execute | Overloaded. Executes a VBScript statement in the current report context. | |
GetLifetimeService | (Inherited from System.MarshalByRefObject) | |
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. | |
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. | |
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. | |
GetReportInfo | Overloaded. Gets a list of reports available in an XML report definition file. | |
GetReportList | Overloaded. Gets a list of reports available in an XML report definition file. | |
InitializeLifetimeService | (Inherited from System.MarshalByRefObject) | |
Load | Overloaded. Loads a report from an XML report definition in stream. | |
ParseExpression | Parses a VBScript expression in the current report context. | |
ParseStatement | Overloaded. Parses a VBScript statement in the current report context. | |
Overloaded. Prints the current report with default printer settings, not showing the print progress dialog. | ||
PrintDialog | Overloaded. Shows the standard print dialog, allowing the user to print the current document. | |
Render | Renders the report into an internal collection of images. | |
RenderToFile | Renders the report into a file. | |
RenderToFilter | Renders the report into an ExportFilter object. | |
RenderToStream | Overloaded. Renders the report into a System.IO.Stream object. | |
Save | Overloaded. Saves the current report definition to a file. | |
SetCreationDevice | Assigns specified values to the CreationDevice and CreationPrinterName properties. Using this method is more efficient than setting the two properties individually. | |
ToString | (Inherited from System.ComponentModel.Component) |
Name | Description | |
---|---|---|
Finalize | (Inherited from System.ComponentModel.Component) | |
GetService | (Inherited from System.ComponentModel.Component) | |
MemberwiseClone | Overloaded. (Inherited from System.MarshalByRefObject) | |
OnEndPage | Raises the EndPage event. | |
OnEndReport | Raises the EndReport event. | |
OnEndSection | Raises the EndSection event. | |
OnNoReportData | Raises the NoData event. | |
OnPrintSection | Raises the PrintSection event. | |
OnReportError | Raises the ReportError event. | |
OnStartPage | Raises the StartPage event. | |
OnStartReport | Raises the StartReport event. | |
OnStartSection | Raises the StartSection event. |
Name | Description | |
---|---|---|
AddOutlineEntry | Fired before the control adds an outline entry to the report. | |
Disposed | (Inherited from System.ComponentModel.Component) | |
EndPage | Fired when the control finishes rendering each page. | |
EndReport | Fired when the control finishes rendering the report. | |
EndSection | Fired when the control finishes rendering each Section. | |
InitializeParametersDialog | Fired before the control displays the Report Parameters dialog. | |
LongOperation | Occurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation to the user. | |
NoData | Fired when the control starts rendering a report and the data source is empty. | |
PrintSection | Fired before each Section is printed (after it has been formatted.) | |
ReportError | Fired when an error occurs while rendering a report. | |
StartPage | Fired when the control starts rendering each page. | |
StartReport | Fired when the control starts rendering the report, before it opens the source recordset. | |
StartSection | Fired before each Section is formatted. |