Reports for WinForms | ComponentOne
C1.C1Report.4 Assembly / C1.C1Rdl.Rdl2008 Namespace / C1RdlReport Class
Properties Methods Events


In This Topic
    C1RdlReport Class Members
    In This Topic

    The following tables list the members exposed by C1RdlReport.

    Public Constructors
     NameDescription
    Public ConstructorInitializes a new instance of the C1RdlReport class.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets or sets the author of the report.  
    Public PropertyGets or sets the rate, in seconds, at which the report page (when rendered as HTML) automatically refreshes. Must be nonnegative. If omitted or zero, the report page should not automatically refresh. Max: 2147483647. Default: 0.  
    Public PropertyGets the Body object describing how the body of the report is structured and rendered.  
    Public PropertyGets a C1.C1Preview.C1PrintDocument object representing the report. Note that if the report is empty, it is rendered before this property returns. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets the Classes collection containing info about classes to instantiate during report initialization.  
    Public PropertyGets or sets the string containing definitions for custom functions to be used in expressions in the report. Custom functions must be instance methods. If a function OnInit() is defined within code, it is called during parameter, report and page header/footer initialization. The function must be defined as Protected and Overrides.  
    Public PropertyGets the CodeModules collection containing code modules to make available to the report for use in expressions.  
    Public PropertyGets or sets a value indicating that all whitespace in containers (such as Body and Rectangle) should be consumed when contents grow rather than preserving the minimum whitespace between the contents and the container.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets the CustomProperties object containing custom information to be handed to the report rendering component  
    Public PropertyGets or sets the name of a top level element that represents the report data. Default: Report. Must be a CLS-compliant identifier.  
    Public PropertyGets or sets a value indicating whether leaf-level values (for example, text box values and chart data values) should render as elements or attributes.  
    Public PropertyGets or sets the schema or namespace to use for the report data rendering.  
    Public PropertyGets or the data that is displayed as part of the report.  
    Public PropertyGets the data sources from which data sets are taken for this report.  
    Public PropertyGets or sets the location to a transformation to apply to a report data rendering. This can be a full folder path (for example, “/xsl/xfrm.xsl”) or relative path (for example “xfrm.xsl”). Relative paths start in the same folder as the report.  
    Public PropertyGets or sets a value indicating that variables throughout the report are not required to be pre-evaluated at the start of report processing and may be evaluated on-demand based on usage. Deferred variable evaluation can improve performance but should not be used if any variables are time-dependent.  
    Public PropertyGets or sets the description of the report.  
    Public PropertyOverridden. Overridden. Returns the current report's Description (used to identify reports in print tasks and so on).  
    Public PropertyGets the EmbeddedImages collection containing images embedded in the report.  
    Public PropertyGets or sets the type of metafiles created by the current report. The default is System.Drawing.Imaging.EmfType.EmfPlusOnly.  
    Public PropertyGets the date/time when the report began generating. If this is a subreport then the master report's ExecutionTime is returned. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets the file name from which the current report definition has been loaded, or where it has been last saved. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyIf 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. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets a value indicating whether the current report contains any Subreport items.  
    Public PropertyGets a value that determines whether a report is currently being generated. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets a value indicating whether the current report has not been generated (i.e. has no generated pages).

    Note that this property does not depend on whether a report definition has been loaded into the current report.

    (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets or sets the primary language of the text. Used as the default for all language-dependent expressions in the report.  
    Public PropertyGets the Page object containing page layout information about the report.  
    Public PropertyGets or sets the RDL format version of the currently loaded report definition.

    Changing the value of this property after a report has been loaded allows to save it in the newly specified format version.

    (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets or sets an Xml string containing the complete report definition. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets the ReportParameters collection containing parameters of the report.  
    Public PropertyGets or sets a value indicating whether a dialog allowing to input values for some or all of the report parameters (elements of the ReportParameters collection) should be shown to the user before the report generates. To include or exclude parameters from the dialog, use ReportParameter.Hidden.

    The default value is true.

     
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets 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 PropertyGets or sets arbitrary data associated with the current report. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets the Variables collection containing variables defined for the report as a whole.  
    Public PropertyGets the collection of warnings produced when the current report was generated. If this is a subreport then the master report's collection of warnings is returned. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public PropertyGets or sets the width of the report.  
    Top
    Protected Properties
    Public Methods
     NameDescription
    Public MethodOverridden. Copies properties from another C1RdlReport to the current object.  
    Public MethodOverridden. Clears the current report, sets all properties to their default values.  
    Public MethodClears the pages and other info produced by the document generation. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverloaded. Releases the resoureces used by C1.C1Preview.C1PrintDocument. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodScans the current report definition and retrieves the list of report names (Subreport.ReportName) of Subreport items contained within the current report.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodTests whether a specified RDL format version is supported by the current component. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public MethodOverloaded. Loads a report definition from a stream into the current report. The stream should contain an RDL report definition in the supported format. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public MethodRenders the report. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public MethodOverloaded. Saves the currently loaded report definition to a stream. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Public Method (Inherited from System.ComponentModel.Component)
    Top
    Protected Methods
     NameDescription
    Protected MethodOverridden. Overridden. Clears all temporary data created during report generation.  
    Protected MethodDestructs the current instance of C1RdlReportBase. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodOverloaded.  (Inherited from System.MarshalByRefObject)
    Top
    Public Events
     NameDescription
    Public Event (Inherited from System.ComponentModel.Component)
    Public EventOccurs periodically during report generation. Allows to provide progress indication and the ability to cancel generation to the user. (Inherited from C1.C1Rdl.C1RdlReportBase)
    Top
    See Also