ComponentOne AutoComplete for ASP.NET Web Forms
C1.C1Report.4 Assembly / C1.C1Report Namespace / C1Report Class
Properties Methods Events

In This Topic
    C1Report Class Members
    In This Topic

    The following tables list the members exposed by C1Report.

    Public Constructors
     NameDescription
    Public ConstructorC1Report ConstructorInitializes a new instance of the C1Report component.  
    Top
    Public Properties
     NameDescription
    Public PropertyActualCreationDeviceGets 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.  
    Public PropertyActualCreationPrinterNameGets 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.  
    Public PropertyActualRightToLeftGets the actual right-to-left value that is being used. The value is obtained using the following rules:
    1. If RightToLeft is not null, then that value is used.
    2. If the current report is a sub-report, then ActualRightToLeft of the owner subreport field is used.
    3. Else the value of C1FlexReport.DefaultRightToLeft static property is used.
     
    Public PropertyAvailableHeightGets 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.  
    Public PropertyC1DocumentGets 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.  
    Public PropertyCancelSpecifies whether to cancel generation of the current report.  
    Public PropertyColorizeHyperlinksGets 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 PropertyCompatibilityOptionsGets the CompatibilityOptions object which determines compatibility with previous versions of C1Report.  
    Public PropertyContainer (Inherited from System.ComponentModel.Component)
    Public PropertyCreationDeviceGets 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.  
    Public PropertyCreationDpiGets or sets the resolution (DPI) used when generating the report.  
    Public PropertyCreationGraphicsGets 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.  
    Public PropertyCreationPrinterNameGets 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.

     
    Public PropertyDataSourceGets a reference to the report's DataSource object.  
    Public Propertystatic (Shared in Visual Basic)DefaultRightToLeftGets or sets the value used as the default for the RightToLeft property.  
    Public PropertyDocumentGets a System.Drawing.Printing.PrintDocument object that can be used to render the report to a printer or into a print preview control.  
    Public PropertyDoEventsSpecifies whether the control should handle Windows messages while rendering reports.  
    Public PropertyEmfTypeGets or sets the type of metafiles created by the current report. The default is System.Drawing.Imaging.EmfType.EmfOnly.  
    Public PropertyExposeScriptObjectsSpecifies whether script objects added with the AddScriptObject(String,Object) method should be exposed to subreports.  
    Public PropertyFieldsGets the collection of Field objects in the report definition.  
    Public PropertyFontGets or sets the default font for new fields.  
    Public PropertyFontProcessingOptionsGets the FontProcessingOptions object which determines how font substitution and embedding are handled when the report generates.  
    Public PropertyGeneratingCompleteIf 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 PropertyGlobalScriptsGets 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.  
    Public PropertyGroupsGets a collection with all the groups in the report.  
    Public PropertyGrowShrinkModeGets or sets the method used to process CanGrow/CanShrink fields.  
    Public PropertyIgnoreScriptErrorsSpecifies whether the component should ignore script errors by default.  
    Public PropertyIsBusyGets a value that determines whether a report is currently being generated.  
    Public PropertyLabelOffsetGets or sets the position of the first label on a partially used sheet.  
    Public PropertyLayoutGets a reference to the report's Layout object.  
    Public PropertyMaxPagesGets or sets the maximum number of pages allowed for a report.  
    Public PropertyOnCloseGets or sets the VBScript that is executed when the report finishes rendering.  
    Public PropertyOnErrorGets or sets the VBScript that is executed when an error occurs.  
    Public PropertyOnNoDataGets or sets the VBScript that is executed when the report starts rendering and its source recordset is empty.  
    Public PropertyOnOpenGets or sets the VBScript that is executed when the report starts rendering.  
    Public PropertyOnPageGets or sets the VBScript that is executed when a new page is created.  
    Public PropertyOutlineRootLevelGets or sets the starting outline level for the groups in this report.  
    Public PropertyPageGets or sets the current page number.  
    Public PropertyPageImagesGets 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.  
    Public PropertyPageRenderingModeGets 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.  
    Public PropertyParentReportGets the main report that contains this subreport (null for main reports).  
    Public PropertyRecordsPerPageGets or sets the number of detail records to render per page or group.  
    Public PropertyReportDefinitionGets or sets an Xml string containing the complete report definition.  
    Public PropertyReportInfoGets or sets a ReportInfo object containing report metadata.  
    Public PropertyReportNameGets or sets the name of the report (used with the Load method).  
    Public PropertyRightToLeftGets 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.

     
    Public PropertySectionsGets the collection of Section objects in the report definition.  
    Public PropertySite (Inherited from System.ComponentModel.Component)
    Public PropertyTagGets or sets extra data needed by the calling program.  
    Public PropertyUseGdiPlusTextRenderingGets 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 PropertyUsePrinterResolutionSpecifies whether the component should use the .NET printing support to obtain high-resolution graphics.  
    Top
    Public Methods
     NameDescription
    Public MethodAddScriptObjectOverloaded. Adds an object to the report's script context.  
    Public MethodBeginInitSignals the object that initialization is starting.  
    Public MethodClearClears the current report.  
    Public MethodClearGeneratedPagesClears the pages and other info created during report generation. This method does not clear the report definition though.  
    Public MethodCopyFromCopies a report definition from another C1Report component.  
    Public MethodCreateObjRef (Inherited from System.MarshalByRefObject)
    Public MethodDispose (Inherited from System.ComponentModel.Component)
    Public MethodEndInitSignals the object that initialization is complete.  
    Public MethodEvaluateOverloaded. Evaluates a VBScript expression in the current report context.  
    Public MethodExecuteOverloaded. Executes a VBScript statement in the current report context.  
    Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodGetPageCountGets 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 MethodGetPageImageGets 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 MethodGetPageImagesEnumerates 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 MethodGetReportInfoOverloaded. Gets a list of reports available in an XML report definition file.  
    Public Methodstatic (Shared in Visual Basic)GetReportListOverloaded. Gets a list of reports available in an XML report definition file.  
    Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodLoadOverloaded. Loads a report from an XML report definition in stream.  
    Public MethodParseExpressionParses a VBScript expression in the current report context.  
    Public MethodParseStatementOverloaded. Parses a VBScript statement in the current report context.  
    Public MethodPrintOverloaded. Prints the current report with default printer settings, not showing the print progress dialog.  
    Public MethodPrintDialogOverloaded. Shows the standard print dialog, allowing the user to print the current document.  
    Public MethodRenderRenders the report into an internal collection of images.  
    Public MethodRenderToFileRenders the report into a file.  
    Public MethodRenderToFilterRenders the report into an ExportFilter object.  
    Public MethodRenderToStreamOverloaded. Renders the report into a System.IO.Stream object.  
    Public MethodSaveOverloaded. Saves the current report definition to a file.  
    Public MethodSetCreationDeviceAssigns specified values to the CreationDevice and CreationPrinterName properties. Using this method is more efficient than setting the two properties individually.  
    Public MethodToString (Inherited from System.ComponentModel.Component)
    Top
    Public Events
     NameDescription
    Public EventAddOutlineEntryFired before the control adds an outline entry to the report.  
    Public EventDisposed (Inherited from System.ComponentModel.Component)
    Public EventEndPageFired when the control finishes rendering each page.  
    Public EventEndReportFired when the control finishes rendering the report.  
    Public EventEndSectionFired when the control finishes rendering each Section.  
    Public EventInitializeParametersDialogFired before the control displays the Report Parameters dialog.  
    Public EventLongOperationOccurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation to the user.  
    Public EventNoDataFired when the control starts rendering a report and the data source is empty.  
    Public EventPrintSectionFired before each Section is printed (after it has been formatted.)  
    Public EventReportErrorFired when an error occurs while rendering a report.  
    Public EventStartPageFired when the control starts rendering each page.  
    Public EventStartReportFired when the control starts rendering the report, before it opens the source recordset.  
    Public EventStartSectionFired before each Section is formatted.  
    Top
    See Also

    Reference

    C1Report Class
    C1.C1Report Namespace