| Name | Description | |
|---|---|---|
 | C1FlexReport Constructor | Initializes a new instance of the C1FlexReport class. |
The following tables list the members exposed by C1FlexReport.
| Name | Description | |
|---|---|---|
| C1FlexReport Constructor | Initializes a new instance of the C1FlexReport class. |
| Name | Description | |
|---|---|---|
 | ActualCulture | Gets the actual culture used in report, returns System.Globalization.CultureInfo.CurrentCulture if Culture is null. |
| ActualRightToLeft | Gets the actual right-to-left value that is being used. The value is obtained using the following rules:
|
| AsyncMethodsUseAwaitPattern | Gets 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.Xaml.Document.C1DocumentSource) |
| 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 in paginated mode (i.e. when C1.Xaml.Document.C1DocumentSource.IsBusy and Paginated are true). If C1.Xaml.Document.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. |
| BasePath | Gets or sets the StorageFolder that is used to search for any additional files specified with relative path names. 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 ApplicationData.Current.LocalFolder is used. |
| BehaviorOptions | Gets the BehaviorOptions object containing options controlling the behavior of the report. |
| BusyState | Gets the current busy state of the current C1.Xaml.Document.C1DocumentSource. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Cancel | Specifies whether to cancel generation of the current report. |
| Credential | Overridden. Gets or sets the default credential used during rendering of the report. |
| Culture | Gets 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. |
| CurrentDataScope | For internal use. Specifies the current data scope. |
| DataSource | Gets or sets a reference to the report's main DataSource, or null if the report is unbound. |
| DataSourceName | Gets 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. |
| DataSources | Gets the collection of DataSource objects used in report. |
 | DefaultBasePath | Gets or sets the Windows.Storage.StorageFolder object that specifies the default folder used to resolve relative file names. By default this property is null, in which case ApplicationData.Current.LocalFolder is used. |
| DefaultPrintOptions | Gets the C1.Xaml.Document.C1PrintOptions object defining default print options used by printing methods of C1.Xaml.Document.C1DocumentSource. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| DefaultRightToLeft | Gets or sets the value used as the default for the RightToLeft property. |
| Dirty | Gets a value indicating whether the current content is dirty and does not correspond to the current values of Paginated etc. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Document | Overridden. Gets a C1.Xaml.Document.C1Document object produced by the current C1FlexReport during report rendering. |
| DocumentName | Overridden. Overriden. Gets the user-frienly name for this C1FlexReport object. |
| DoEvents | Specifies whether the control should handle Windows messages while rendering reports in synchronious mode. |
| ExposeScriptObjects | Specifies whether script objects of report should be exposed to subreports. |
| Features | Overridden. Overridden. Gets a C1.Xaml.Document.C1DocumentSourceFeatures object defining features of the C1FlexReport. |
| Fields | Gets the collection of Field objects in the report definition. |
| FileName | Gets the filename that was used to load or save the report. |
| Font | Gets or sets the default font used by report fields. |
| FormatVersion | Gets the C1.Xaml.Document.Serialization.C1FormatVersion object specifying the version of the report definition files. |
| 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 the value indicating whether the current C1.Xaml.Document.C1DocumentSource busy. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| IsDisposed | Gets a value indicating whether this C1.Xaml.Document.C1DocumentSource is disposed and can not be longer used. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| 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. |
| Log | Gets the C1.Xaml.Document.LogEntryList containing the list of events which occured during the last operation (generating, exporting etc). (Inherited from C1.Xaml.Document.C1DocumentSource) |
| 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. |
| Overlay | Gets the Watermark object defining properties of the report's overlay. |
| Page | Gets or sets the current page number. |
| PageCount | Gets the number of already generated pages. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| PageSettings | Overridden. Overriden. This is shortcut to the page settings returned by the Layout object accessible via the Layout property. |
| Paginated | Gets or sets a value indicating whether the content should be represented as set of fixed sized pages. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Parameters | Gets a collection of parameters used to generate report. |
| 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. |
| SupportedExportProviders | Overridden. Overridden. Gets an array of exporters supported by the current document source object. |
| Tag | Gets or sets arbitrary user-defined data. |
| Watermark | Gets the Watermark object defining properties of the report's watermark. |
| Name | Description | |
|---|---|---|
 | AddToLog | Overloaded. Adds log entry to the Log list. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| CancelAsync | Cancels currently executed async action and waits until action will be actually cancelled. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Clear | Clears the current report. |
| ClearContent | Clear generated content and sets Dirty to true. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| CopyDefinitionFrom | Copies a report definition from another C1FlexReport component. Please note, subreports referenced from the report via SubreportField or Field are not cloned. |
| Dispose | Overloaded. Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Evaluate | Overloaded. Evaluates a VBScript expression in the current report context. |
| Execute | Overloaded. Executes a VBScript statement in the current report context. |
| ExecuteAction | Executes an action specified by the C1.Xaml.Document.C1DocumentAction object. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExecuteActionAsync | Non-blocking (asynchronous) version of the ExecuteAction method. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExecuteActionAsyncEx | (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Export | Exports the document into a stream in an external format using the specified export filter. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExportAsync | Non-blocking (asynchronous) version of the Export method. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExportAsyncEx | (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Generate | Generates the document. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GenerateAsync | Non-blocking (asynchronous) version of the Generate method. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GenerateAsyncEx | (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GetDocumentRange | Creates the C1.Xaml.Document.C1DocumentRange object on the base of two text positions specified by C1.Xaml.Document.C1DocumentTextPosition objects. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GetPageDocumentRange | Creates a C1.Xaml.Document.C1DocumentRange object that includes the specified page. This method can return null if the page contains no text. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GetReportList | Overloaded. Gets a list of reports available in an C1.Xaml.Document.Serialization.XmlDocumentWrapperBase. |
| GetReportListAsync | Gets a list of reports available in an XML report definition file. |
| GetWholeDocumentRange | Creates a C1.Xaml.Document.C1DocumentRange object that includes the whole document. This method can return null if the document contains no text. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GetWordDocumentRange | Creates a C1.Xaml.Document.C1DocumentRange object that defines a word containing a specified position in the document. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| IsGenerateAllowed | Returns a value indicating whether the Generate method can be called at the moment. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Load | Overloaded. Loads a document from C1.Xaml.Document.Serialization.XmlDocumentWrapperBase. |
| LoadAsync | Loads a report from an XML report definition file. |
| LoadFromXmlDocument | Loads a report from an System.Xml.XmlDocument. |
| ParseExpression | Parses a VBScript expression in the current report context. |
| ParseStatement | Parses a VBScript statement in the current report context. |
| PopDataScope | For internal use. Pop the current data scope. |
| PushDataScope | For internal use. Push the specific data scope on top of the current data scope. |
| Render | Renders the report. This method is a shortcut to the Generate method on the base class. |
| RenderAsync | Non-blocking (asynchronous) version of the Render method. This method is a shortcut to the GenerateAsync method on the base class. |
| RenderAsyncEx | Non-blocking (asynchronous) version of the Render method. This method is a shortcut to the C1.Xaml.Document.C1DocumentSource.GenerateAsyncEx method on the base class. |
| RenderToFilter | Renders the report into an C1.Xaml.Document.Export.ExportFilter object. This method is a shortcut to the Export method on the base class. |
| RenderToFilterAsync | Non-blocking (asynchronous) version of the RenderToFilter method. This method is a shortcut to the ExportAsync method on the base class. |
| RenderToFilterAsyncEx | Non-blocking (asynchronous) version of the RenderToFilter method. This method is a shortcut to the C1.Xaml.Document.C1DocumentSource.ExportAsyncEx method on the base class. |
| Save | Overloaded. Saves the current report definition to a stream. |
| SaveAsync | Overloaded. Saves the current report definition to a file. |
| ShowPrintUIAsync | Overloaded. Initiates the user interface for printing a document. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ValidateParameters | Validates the current parameter values, refreshes their valid values' lists if the values are valid. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ValidateParametersAsync | Non-blocking (asynchronous) version of the ValidateParameters method. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ValidateParametersAsyncEx | (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Name | Description | |
|---|---|---|
 | CreateParametersCollection | Overridden. Overriden. Creates ReportParameterCollection collection containing list of report parameters. |
| FirePageCountChanged | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Init | Overridden. Overriden. Performs additional initializations of this C1FlexReport instance. |
| OnBusyStateChanged | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnDirtyChanged | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnEndPage | Raises the EndPage event. |
| OnEndReport | Raises the EndReport event. |
| OnExportCompleted | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnGenerateCompleted | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnGetLinkTargetPositionCompleted | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnGetPageCompleted | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnGetScriptObject | Raises the GetScriptObject event. |
| OnNoReportData | Raises the NoData event. |
| OnPageCountChanged | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnPagesClear | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnPagesLoaded | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnPrintSection | Raises the PrintSection event. |
| OnReportError | Raises the ReportError event. |
| OnSecurityError | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| OnStartPage | Raises the StartPage event. |
| OnStartReport | Raises the StartReport event. |
| OnStartSection | Raises the StartSection event. |
| OnValidateParametersCompleted | For internal use. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ReadProp | Override in derived classes to provide advanced persistence mechanism. Use C1.Xaml.Document.Serialization.C1ReaderBase.PropName to determine the name of the current property, use C1ReaderBase.ReadXXX(...) to read property value. |
| Write | Override in derived classes to provide advanced persistence mechanism. Use C1.Xaml.Document.Serialization.C1WriterBase methods to write additional object properties. |
| Name | Description | |
|---|---|---|
 | BusyStateChanged | Occurs when the BusyState property value changes. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| DirtyChanged | Occurs when the Dirty property value changes. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| EndPage | Occurs when a page finishes rendering. |
| EndReport | Occurs when the report finishes rendering. |
| ExportCompleted | Occurs when the ExportAsync method has completed. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GenerateCompleted | Occurs when the GenerateAsync method has completed. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GetScriptObject | Occurs when an unknown object is found in the report's script or expression. |
| LongOperation | Occurs 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.Xaml.Document.C1DocumentSource) |
| NoData | Occurs when the report starts rendering and the main report data source is empty. |
| PageCountChanged | Occurs when the PageCount property value changes. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| PrintSection | Occurs before each Section is printed (after it has been formatted.) |
| PrintTaskCompleted | Occurs when the print task started with ShowPrintUIAsync method is finished. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| RenderCompleted | Occurs when the RenderAsync method has completed. |
| ReportDefinitionChanged | Occurs when the current report definition changes. |
| ReportError | Occurs when an error occurs while rendering a report. |
| SecurityError | Occurs 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.Xaml.Document.C1DocumentSource) |
| StartPage | Occurs when a new page starts rendering. |
| StartReport | Occurs when the report starts rendering, before it opens the datasources and checks parameters. |
| StartSection | Occurs before each Section is formatted. |
| ValidateParametersCompleted | Occurs when the ValidateParametersAsync method has completed. (Inherited from C1.Xaml.Document.C1DocumentSource) |