ComponentOne FlexReport for WinForms
C1.Win.FlexReport.4.5.2 Assembly / C1.Win.FlexReport Namespace / C1FlexReport Class
Properties Methods Events


In This Topic
    C1FlexReport Class Members
    In This Topic

    The following tables list the members exposed by C1FlexReport.

    Public Constructors
     NameDescription
    Public ConstructorInitializes a new instance of the C1FlexReport class.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets the actual culture used in report, returns System.Globalization.CultureInfo.CurrentCulture if Culture is null.  
    Public PropertyGets 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 DefaultRightToLeft static property is used.
     
    Public PropertyGets or sets a value indicating whether calls to async methods of the current document source expect the async/await pattern to be used by the calling code. If this property is true, then the *Completed events (such as GenerateCompleted, GenerateCompleted and others) do not fire. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public PropertyGets 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 in paginated mode (i.e. when C1.Win.C1Document.C1DocumentSource.IsBusy and Paginated are true). If C1.Win.C1Document.C1DocumentSource.IsBusy is false then -1 is returned. If Paginated is false then double.MaxValue is returned. Note that if used in OnPrint/OnFormat scripts, this value does NOT account for the current section's height. For subreports this property returns AvailableHeight of the master report.  
    Public PropertyGets or sets the StorageFolder that is used to search for any additional files specified with relative path names. This property is updated automatically when a report is loaded from a file. If you load a report definition from a System.IO.MemoryStream or via the ReportDefinition property, make sure that WorkingDirectory has the correct value if the report template contains items with relative file names. If this property is null then DefaultBasePath is used, otherwise System.Environment.CurrentDirectory is used.  
    Public PropertyGets the BehaviorOptions object containing options controlling the behavior of the report.  
    Public PropertyGets the current busy state of the current C1.Win.C1Document.C1DocumentSource. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public PropertySpecifies whether to cancel generation of the current report.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyOverridden. Gets or sets the default credential used during rendering of the report.  
    Public PropertyGets or sets the System.Globalization.CultureInfo determining the current report culture. This culture is used to convert values to/from strings. By default it is null, in which case the System.Globalization.CultureInfo.CurrentCulture is used.  
    Public PropertyFor internal use. Specifies the current data scope.  
    Public PropertyGets or sets a reference to the report's main DataSource, or null if the report is unbound.  
    Public PropertyGets or sets the name of the report's main data source. This name should match the name of a data source in the DataSources collection.  
    Public PropertyGets the collection of DataSource objects used in report.  
    Public Propertystatic (Shared in Visual Basic)Gets or sets the default directory that is used to resolve relative file names. By default this property is null, in which case Enviroment.CurrentDirectory is used.  
    Public PropertyGets the C1.Win.C1Document.C1PrintOptions object defining default print options used by printing methods of C1.Win.C1Document.C1DocumentSource. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public Propertystatic (Shared in Visual Basic)Gets or sets the value used as the default for the RightToLeft property.  
    Public PropertyGets a value indicating whether the current content is dirty and does not correspond to the current values of Paginated etc. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public PropertyOverridden. Gets a C1.Win.C1Document object produced by the current C1FlexReport during report rendering.  
    Public PropertyOverridden. Overriden. Gets the user-frienly name for this C1FlexReport object.  
    Public PropertySpecifies whether the control should handle Windows messages while rendering reports in synchronious mode.  
    Public PropertySpecifies whether script objects of report should be exposed to subreports.  
    Public PropertyOverridden. Overridden. Gets a C1.Win.C1Document.C1DocumentSourceFeatures object defining features of the C1FlexReport.  
    Public PropertyGets the collection of Field objects in the report definition.  
    Public PropertyGets the filename that was used to load or save the report.  
    Public PropertyGets or sets the default font used by report fields.  
    Public Propertystatic (Shared in Visual Basic)Gets the C1.Win.C1Document.Serialization.C1FormatVersion object specifying the version of the report definition files.  
    Public PropertyGets 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 PropertyGets a collection with all the groups in the report.  
    Public PropertyGets or sets the method used to process CanGrow/CanShrink fields.  
    Public PropertySpecifies whether the component should ignore script errors by default.  
    Public PropertyGets the value indicating whether the current C1.Win.C1Document.C1DocumentSource busy. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public PropertyGets a value indicating whether this C1.Win.C1Document.C1DocumentSource is disposed and can not be longer used. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public PropertyGets or sets the position of the first label on a partially used sheet.  
    Public PropertyGets a reference to the report's Layout object.  
    Public PropertyGets the C1.Win.C1Document.LogEntryList containing the list of events which occured during the last operation (generating, exporting etc). (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public PropertyGets or sets the maximum number of pages allowed for a report.  
    Public Propertystatic (Shared in Visual Basic)Gets or sets the type of device used to provide System.Drawing.Graphics used to measure/calculate layouts of C1FlexReport objects, when used GDI/GDI+ functions. If this property is set to C1.Win.C1Document.MeasurementDevice.Printer, MeasurementPrinterName specifies the printer.  
    Public Propertystatic (Shared in Visual Basic)Gets or sets the name of the printer used to provide System.Drawing.Graphics used to measure/calculate layouts of C1FlexReport objects, when used GDI/GDI+ functions. This property is only used if MeasurementDevice is set to C1.Win.C1Document.MeasurementDevice.Printer.  
    Public PropertyGets or sets the VBScript that is executed when the report finishes rendering.  
    Public PropertyGets or sets the VBScript that is executed when an error occurs.  
    Public PropertyGets or sets the VBScript that is executed when the report starts rendering and its source recordset is empty.  
    Public PropertyGets or sets the VBScript that is executed when the report starts rendering.  
    Public PropertyGets or sets the VBScript that is executed when a new page is created.  
    Public PropertyGets the Watermark object defining properties of the report's overlay.  
    Public PropertyGets or sets the current page number.  
    Public PropertyGets the number of already generated pages. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public PropertyOverridden. Overriden. This is shortcut to the page settings returned by the Layout object accessible via the Layout property.  
    Public PropertyGets a collection of parameters used to generate report.  
    Public PropertyGets the main report that contains this subreport (null for main reports).  
    Public PropertyGets or sets the number of detail records to render per page or group.  
    Public PropertyGets or sets an Xml string containing the complete report definition.  
    Public PropertyGets or sets a ReportInfo object containing report metadata.  
    Public PropertyGets or sets the name of the report (used with the Load method).  
    Public PropertyGets 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 PropertyGets the collection of Section objects in the report definition.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyOverridden. Overridden. Gets an array of exporters supported by the current document source object.  
    Public PropertyGets or sets arbitrary user-defined data.  
    Public PropertyGets the Watermark object defining properties of the report's watermark.  
    Top
    Protected Properties
     NameDescription
    Protected Property (Inherited from System.ComponentModel.Component)
    Protected Property (Inherited from System.ComponentModel.Component)
    Protected Property (Inherited from System.ComponentModel.Component)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds log entry to the Log list. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodCancels currently executed async action and waits until action will be actually cancelled. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodClears the current report.  
    Public MethodClear generated content and sets Dirty to true. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodCopies a report definition from another C1FlexReport component. Please note, subreports referenced from the report via SubreportField or Field are not cloned.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverloaded. Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodOverloaded. Evaluates a VBScript expression in the current report context.  
    Public MethodOverloaded. Executes a VBScript statement in the current report context.  
    Public MethodExecutes an action specified by the C1.Win.C1Document.C1DocumentAction object. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the ExecuteAction method. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public Method (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodExports the document into a stream in an external format using the specified export filter. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the Export method. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public Method (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodGenerates the document. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the Generate method. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public Method (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodCreates the C1.Win.C1Document.C1DocumentRange object on the base of two text positions specified by C1.Win.C1Document.C1DocumentTextPosition objects. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodCreates a C1.Win.C1Document.C1DocumentRange object that includes the specified page. This method can return null if the page contains no text. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodOverloaded. Returns a System.Drawing.Imaging.Metafile representing the specified page.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a list of reports available in an C1.Win.C1Document.Serialization.XmlDocumentWrapperBase.  
    Public MethodCreates a C1.Win.C1Document.C1DocumentRange object that includes the whole document. This method can return null if the document contains no text. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodCreates a C1.Win.C1Document.C1DocumentRange object that defines a word containing a specified position in the document. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodReturns a value indicating whether the Generate method can be called at the moment. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodOverloaded. Loads a report from an XML report definition in stream.  
    Public MethodParses a VBScript expression in the current report context.  
    Public MethodParses a VBScript statement in the current report context.  
    Public MethodOverloaded. Prints the generated document. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodRenders the report. This method is a shortcut to the Generate method on the base class.  
    Public MethodNon-blocking (asynchronous) version of the Render method. This method is a shortcut to the GenerateAsync method on the base class.  
    Public MethodNon-blocking (asynchronous) version of the Render method. This method is a shortcut to the C1.Win.C1Document.C1DocumentSource.GenerateAsyncEx method on the base class.  
    Public MethodRenders the report into an C1.Win.C1Document.Export.ExportFilter object. This method is a shortcut to the Export method on the base class.  
    Public MethodNon-blocking (asynchronous) version of the RenderToFilter method. This method is a shortcut to the ExportAsync method on the base class.  
    Public MethodNon-blocking (asynchronous) version of the RenderToFilter method. This method is a shortcut to the C1.Win.C1Document.C1DocumentSource.ExportAsyncEx method on the base class.  
    Public MethodOverloaded. Saves the current report definition to a file.  
    Public Method (Inherited from System.ComponentModel.Component)
    Public MethodValidates the current parameter values, refreshes their valid values' lists if the values are valid. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the ValidateParameters method. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public Method (Inherited from C1.Win.C1Document.C1DocumentSource)
    Top
    Protected Methods
     NameDescription
    Protected MethodOverridden. Overriden. Creates ReportParameterCollection collection containing list of report parameters.  
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodOverridden. Overriden. Performs additional initializations of this C1FlexReport instance.  
    Protected MethodOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodRaises the EndPage event.  
    Protected MethodRaises the EndReport event.  
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodRaises the GetScriptObject event.  
    Protected MethodRaises the NoData event.  
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodRaises the PrintSection event.  
    Protected MethodRaises the ReportError event.  
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodRaises the StartPage event.  
    Protected MethodRaises the StartReport event.  
    Protected MethodRaises the StartSection event.  
    Protected MethodFor internal use. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Protected MethodOverride in derived classes to provide advanced persistence mechanism. Use C1.Win.C1Document.Serialization.C1ReaderBase.PropName to determine the name of the current property, use C1ReaderBase.ReadXXX(...) to read property value.  
    Protected MethodOverride in derived classes to provide advanced persistence mechanism. Use C1.Win.C1Document.Serialization.C1WriterBase methods to write additional object properties.  
    Top
    Public Events
     NameDescription
    Public EventOccurs when the BusyState property value changes. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public EventOccurs when the Dirty property value changes. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public Event (Inherited from System.ComponentModel.Component)
    Public EventOccurs when a page finishes rendering.  
    Public EventOccurs when the report finishes rendering.  
    Public EventOccurs when the ExportAsync method has completed. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public EventOccurs when the GenerateAsync method has completed. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public EventOccurs when an unknown object is found in the report's script or expression.  
    Public EventOccurs periodically during various document operations. Allows to provide progress indication and the ability to cancel some long operations such as document generation. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public EventOccurs when the report starts rendering and the main report data source is empty.  
    Public EventOccurs when the PageCount property value changes. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public EventOccurs before each Section is printed (after it has been formatted.)  
    Public EventOccurs when the RenderAsync method has completed.  
    Public EventOccurs when the current report definition changes.  
    Public EventOccurs when an error occurs while rendering a report.  
    Public EventOccurs when a securiy exception occurs during a document source operation. This event allows to correct security-related properties like System.Net.NetworkCredential and retry a failed operation with new credentials. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Public EventOccurs when a new page starts rendering.  
    Public EventOccurs when the report starts rendering, before it opens the datasources and checks parameters.  
    Public EventOccurs before each Section is formatted.  
    Public EventOccurs when the ValidateParametersAsync method has completed. (Inherited from C1.Win.C1Document.C1DocumentSource)
    Top
    See Also