StiReport Class
Namespace: Stimulsoft.Report
Properties
| Property | Type | Description |
|---|---|---|
| AutoLocalizeReportOnRun | bool | |
| Column | int | |
| CompiledReport | StiReport | |
| CompilerResults | CompilerResults | |
| CurrentPage | int | |
| CurrentPrintPage | int | |
| GlobalizationManager | IStiGlobalizationManager | |
| Line | int | |
| LineThrough | int | |
| NeedsCompiling | bool | |
| PageCopyNumber | int | |
| PageNofMLocalizationString | string | |
| ReportFile | string | |
| ViewerControl | IStiViewerControl | |
| ViewerForm | Type |
Methods
| Method | Returns | Description |
|---|---|---|
CheckNeedForceInterpretationMode static |
bool | |
| Compile (+5 overloads) | StiReport | Compiles a report. |
| CompileAsync (+5 overloads) | Task<StiReport> | Compiles a report. |
| CompileReportsToAssembly (+1 overloads) | CompilerResults | |
| CompileReportsToAssemblyAsync (+1 overloads) | Task<StiReport> | |
| CompileStandaloneReport | StiReport | Compiles a standalone report and locates it in the specified path. |
| CompileStandaloneReportAsync | Task<StiReport> | Compiles a standalone report and locates it in the specified path. |
| CreateInstance | StiReport | |
CreateNewDashboard static |
StiReport | |
CreateNewForm static |
StiReport | |
CreateNewReport static |
StiReport | |
CreateNewScreen static |
StiReport | |
| Design (+5 overloads) | DialogResult | Calls the designer for the report in the Modal window. |
| DesignV2WithWpf (+3 overloads) | bool | Calls the designer for the report in the Modal window with using WPF technology. |
| DesignWithWpf (+2 overloads) | bool | Calls the designer for the report in the Modal window with using WPF technology. |
Div static (+5 overloads) |
long | |
| ExportDocument (+6 overloads) | StiReport | Exports a rendered report into a file with dialog using the provider. |
| ExportDocumentAsync (+5 overloads) | Task<StiReport> | Exports a rendered report into a file with dialog using the provider. |
| Format | string | |
| GetFontResourceName | string | |
| GetLabel | string | |
| GetParam | object | |
GetReportFromAssembly static (+4 overloads) |
StiReport | Returns a created report from assembly. |
GetReportsFromAssembly static |
StiReport[] | Returns the array of rendered reports from assembly. |
| GetResourceFontName | string | |
| GetResourceFontNames | List |
|
| IIF | object | |
IsEncryptedFile static (+2 overloads) |
bool | Returns true if specified stream contains encrypted report. |
IsJsonFile static (+1 overloads) |
bool | Returns a value indicating whether the specified file contains a JSON report. |
| IsNull | bool | |
IsPackedFile static (+2 overloads) |
bool | Returns a value indicating whether the specified file contains a packed report. |
| LastOnPage | object | |
| Load (+5 overloads) | Assembly | |
| LoadAsync (+4 overloads) | Task<StiReport> | Loads asynchronously a report template from the stream. |
| LoadDocument (+4 overloads) | StiReport | Loads a rendered report from the byte array. |
| LoadDocumentAsync (+4 overloads) | Task<StiReport> | Loads asynchronously a rendered report from the byte array. |
| LoadDocumentFonts | StiReport | |
| LoadDocumentFromJson (+1 overloads) | StiReport | Loads a rendered report from the string. |
| LoadDocumentFromJsonAsync (+1 overloads) | Task<StiReport> | Loads asynchronously a rendered report from the JSON string. |
| LoadDocumentFromString | StiReport | Loads a rendered report from the string. |
| LoadDocumentFromStringAsync | Task<StiReport> | Loads asynchronously a rendered report from the string. |
| LoadDocumentFromUrl | StiReport | Loads a rendered report template from specified url. |
| LoadDocumentFromUrlAsync | Task<StiReport> | Loads asynchronously a rendered report template from specified url. |
| LoadEditableFields (+1 overloads) | StiReport | Loads the editable fields of rendered report from the stream. |
| LoadEncryptedDocument (+2 overloads) | StiReport | Loads an encrypted rendered report from the stream. |
| LoadEncryptedDocumentAsync (+2 overloads) | Task<StiReport> | Loads asynchronously an encrypted rendered report from the stream. |
| LoadEncryptedDocumentFromString | StiReport | Loads an encrypted rendered report from the string. |
| LoadEncryptedDocumentFromStringAsync | Task<StiReport> | Loads asynchronously an encrypted rendered report from the string. |
| LoadEncryptedReport (+2 overloads) | StiReport | Loads an encrypted report template from the stream. |
| LoadEncryptedReportAsync (+2 overloads) | Task<StiReport> | Loads asynchronously an encrypted report template from the stream. |
| LoadEncryptedReportFromString | StiReport | Loads an encrypted report template from the string. |
| LoadEncryptedReportFromStringAsync | Task<StiReport> | Loads asynchronously an encrypted report template from the string. |
| LoadFonts | StiReport | |
| LoadFromJson (+1 overloads) | StiReport | Loads a report template from the string. |
| LoadFromJsonAsync (+1 overloads) | Task<StiReport> | Loads asynchronously a report template from the string. |
| LoadFromString | StiReport | Loads a report template from the string. |
| LoadFromStringAsync | Task<StiReport> | Loads asynchronously a report template from the string. |
| LoadFromUrl | StiReport | Loads a report template from specified url. |
| LoadFromUrlAsync | Task<StiReport> | Loads asynchronously a report template from specified url. |
| LoadPackedDocument (+2 overloads) | StiReport | Loads a packed rendered report from the stream. |
| LoadPackedDocumentAsync (+2 overloads) | Task<StiReport> | Loads asynchronously a packed rendered report from the stream. |
| LoadPackedDocumentFromString | StiReport | Loads a packed rendered report from the string. |
| LoadPackedDocumentFromStringAsync | Task<StiReport> | Loads asynchronously a packed rendered report from the string. |
| LoadPackedReport (+2 overloads) | StiReport | Loads a packed report template from the stream. |
| LoadPackedReportAsync (+2 overloads) | Task<StiReport> | Loads asynchronously a packed report template from the stream. |
| LoadPackedReportFromString | StiReport | Loads a packed report template from the string. |
| LoadPackedReportFromStringAsync | Task<StiReport> | Loads asynchronously a packed report template from the string. |
| LoadReportFromResource (+1 overloads) | StiReport | Loads a report template from the resource. |
| LoadReportFromResourceAsync (+1 overloads) | Task<StiReport> | Loads asynchronously a report template from the resource. |
| LocalizeReport (+1 overloads) | StiReport | Localize a report to the specified culture name. The culture definition must be placed in GlobalizationStrings. |
| MergeDocument | void | Merge a document to the current document. |
| NextIsNull | bool | |
| PreviousIsNull | bool | |
| Print (+7 overloads) | StiReport | Prints the rendered report without print dialog. If the report is not rendered then its rendering starts. |
| PrintAsync (+4 overloads) | Task<StiReport> | Prints the rendered report. If the report is not rendered then its rendering starts. |
PrintReports static (+2 overloads) |
void | Prints the collection of reports. If the report from collection is not rendered then its rendering starts. |
| PrintReportsAsync (+2 overloads) | Task<StiReport> | Prints the collection of reports. If the report from collection is not rendered then its rendering starts. |
| PrintToDotMatrixPrinter (+3 overloads) | StiReport | Prints a report to default dot-matrix printer in the RAW mode in ASCII encoding. |
| PrintWithWpf (+10 overloads) | StiReport | Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly. |
| PrintWithWpfAsync (+7 overloads) | Task<StiReport> | Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly. |
| PrintWithXbap (+10 overloads) | StiReport | |
| RecalculateRenderedPagesSegments | StiReport | Recalculate segments in all rendered pages |
| RegBusinessObject (+3 overloads) | StiReport | Registers the business object in the report. |
| RegBusinessObjectAsync (+1 overloads) | Task<StiReport> | Asynchronously registers the business object in the report. |
| RegCsvData | StiDatabase | Registers a new connection to the CSV data file. |
| RegCsvDataAsync | Task |
Asynchronously registers a new connection to the CSV data file. |
| RegCsvFile | StiDatabase | Registers a new connection to the CSV data file. |
| RegCsvFileAsync | Task |
Registers a new connection to the CSV data file. |
| RegData (+17 overloads) | StiReport | Registers an object in the Data Store. |
| RegDataAsync (+17 overloads) | Task<StiReport> | Asynchronously registers an object in the Data Store. |
| RegDbfData | StiDatabase | Registers a new connection to the DBF data file. |
| RegDbfDataAsync | Task |
Asynchronously registers a new connection to the DBF data file. |
| RegDbfFile | StiDatabase | Registers a new connection to the DBF data file. |
| RegDbfFileAsync | Task |
Registers a new connection to the DBF data file. |
| RegExcelData | StiDatabase | Registers a new connection to the EXCEL data file. |
| RegExcelDataAsync | Task |
Asynchronously registers a new connection to the EXCEL data file. |
| RegExcelFile | StiDatabase | Registers a new connection to the EXCEL data file. |
| RegExcelFileAsync | Task |
Registers a new connection to the EXCEL data file. |
| RegFirebirdConnection | StiDatabase | Registers a Firebird connection. |
| RegFirebirdConnectionAsync | Task |
Asynchronously registers a Firebird connection. |
| RegJsonData | StiDatabase | Registers a new connection to the JSON data file. |
| RegJsonDataAsync | Task |
Asynchronously registers a new connection to the JSON data file. |
| RegJsonFile | StiDatabase | Registers a new connection to the JSON data file. |
| RegJsonFileAsync | Task |
Registers a new connection to the JSON data file. |
| RegMySqlConnection | StiDatabase | Registers a MySQL connection. |
| RegMySqlConnectionAsync | Task |
Asynchronously registers a MySQL connection. |
| RegOdbcConnection | StiDatabase | Registers an ODBC connection. |
| RegOdbcConnectionAsync | Task |
Asynchronously registers an ODBC connection. |
| RegOleDbConnection | StiDatabase | Registers an OLEDB connection. |
| RegOleDbConnectionAsync | Task |
Asynchronously registers an OLEDB connection. |
| RegOracleConnection | StiDatabase | Registers an Oracle connection. |
| RegOracleConnectionAsync | Task |
Asynchronously registers an Oracle connection. |
| RegPostgreSqlConnection | StiDatabase | Registers a PostgreSQL connection. |
| RegPostgreSqlConnectionAsync | Task |
Asynchronously registers a PostgreSQL connection. |
| RegReportDataSources | StiReport | Internal use only. Registers datasources from ReportDataSources property in report dictionary. |
| RegSqlServerConnection | StiDatabase | Registers a SQL Server connection. |
| RegSqlServerConnectionAsync | Task |
Asynchronously registers a SQL Server connection. |
| RegXmlData (+1 overloads) | StiDatabase | Registers a new connection to the XML data file. |
| RegXmlDataAsync (+1 overloads) | Task |
Asynchronously registers a new connection to the XML data file. |
| RegXmlFile | StiDatabase | Registers a new connection to the XML data file. |
| RegXmlFileAsync | Task |
Registers a new connection to the XML data file. |
| Render (+3 overloads) | StiReport | Renders a report. |
| RenderAsync (+2 overloads) | Task<StiReport> | Renders a report. |
| RenderWithWpf (+3 overloads) | StiReport | Renders a report with using WPF technology. |
| ResetAggregateFunctions | StiReport | Resets states of aggregate functions in compiled report. |
| ResetRenderedState | StiReport | Resets a rendered states. |
| Save (+3 overloads) | StiReport | Saves a report template in the stream. |
| SaveAsync (+3 overloads) | Task<StiReport> | Saves asynchronously a report template in the stream. |
| SaveDocument (+3 overloads) | StiReport | Saves a rendered report in the stream. |
| SaveDocumentAsync (+3 overloads) | Task<StiReport> | Saves asynchronously a rendered report in the stream. |
| SaveDocumentJsonToString | string | Saves a rendered report to the string. |
| SaveDocumentJsonToStringAsync | Task |
Saves asynchronously a rendered report to the string. |
| SaveDocumentToByteArray | byte[] | Saves a rendered report to the byte array. |
| SaveDocumentToByteArrayAsync | Task<byte[]> | Saves asynchronously a rendered report to the byte array. |
| SaveDocumentToString | string | Saves a rendered report to the string. |
| SaveDocumentToStringAsync | Task |
Saves asynchronously a rendered report to the string. |
| SaveEditableFields (+1 overloads) | StiReport | Saves the editable fields of rendered report to the stream. |
| SaveEncryptedDocument (+1 overloads) | StiReport | Saves an encrypted rendered report to the stream. |
| SaveEncryptedDocumentAsync (+1 overloads) | Task<StiReport> | Saves asynchronously an encrypted rendered report to the stream. |
| SaveEncryptedDocumentToByteArray | byte[] | Saves an encrypted rendered report to the byte array. |
| SaveEncryptedDocumentToByteArrayAsync | Task<byte[]> | Saves asynchronously an encrypted rendered report to the byte array. |
| SaveEncryptedDocumentToString | string | Saves an encrypted rendered report to the string. |
| SaveEncryptedDocumentToStringAsync | Task |
Saves an encrypted rendered report to the string. |
| SaveEncryptedReport (+1 overloads) | StiReport | Saves an encrypted report template in the stream. |
| SaveEncryptedReportAsync (+1 overloads) | Task<StiReport> | Saves asynchronously an encrypted report template in the stream. |
| SaveEncryptedReportToByteArray | byte[] | Saves an encrypted report template in the byte array. |
| SaveEncryptedReportToByteArrayAsync | Task<byte[]> | Saves asynchronously an encrypted report template in the byte array. |
| SaveEncryptedReportToString | string | Saves an encrypted report template to the string. |
| SaveEncryptedReportToStringAsync | Task |
Saves asynchronously an encrypted report template to the string. |
| SavePackedDocument (+1 overloads) | StiReport | Saves a packed rendered report to the stream. |
| SavePackedDocumentAsync (+1 overloads) | Task<StiReport> | Saves asynchronously a packed rendered report to the stream. |
| SavePackedDocumentToByteArray | byte[] | Saves a packed rendered report to the byte array. |
| SavePackedDocumentToByteArrayAsync | Task<byte[]> | Saves asynchronously a packed rendered report to the byte array. |
| SavePackedDocumentToString | string | Saves a packed rendered report to the string. |
| SavePackedDocumentToStringAsync | Task |
Saves asynchronously a packed rendered report to the string. |
| SavePackedReport (+1 overloads) | StiReport | Saves a packed report template in the stream. |
| SavePackedReportAsync (+1 overloads) | Task<StiReport> | Saves asynchronously a packed report template in the stream. |
| SavePackedReportToByteArray | byte[] | Saves a packed report template in the byte array. |
| SavePackedReportToByteArrayAsync | Task<byte[]> | Saves asynchronously a packed report template in the byte array. |
| SavePackedReportToString | string | Saves a packed report template to the string. |
| SavePackedReportToStringAsync | Task |
Saves a packed report template to the string. |
| SaveReportSourceCode (+5 overloads) | string | Saves the report source code to the string. |
| SaveSnapshot (+1 overloads) | StiReport | Saves a report template with embedded data |
| SaveSnapshotAsync (+1 overloads) | Task<StiReport> | Saves asynchronously a report template with embedded data. |
| SaveSnapshotToByteArray | byte[] | Saves a report template with embedded data to a byte array. |
| SaveSnapshotToByteArrayAsync | Task<byte[]> | Saves asynchronously a report template with embedded data to a byte array. |
| SaveToByteArray | byte[] | Saves a report template in the byte array. |
| SaveToByteArrayAsync | Task<byte[]> | Saves asynchronously a report template in the byte array. |
| SaveToJson | StiReport | Saves a report template in the file. |
| SaveToJsonAsync | Task<StiReport> | Saves asynchronously a report template in the file. |
| SaveToJsonString | string | Saves a report template to the string. |
| SaveToJsonStringAsync | Task |
Saves asynchronously a report template to the string. |
| SaveToString | string | Saves a report template to the string. |
| SaveToStringAsync | Task |
Saves asynchronously a report template to the string. |
| Show (+4 overloads) | StiReport | Shows a rendered report. If the report is not rendered then its rendering starts. |
| ShowDotMatrix (+4 overloads) | StiReport | Shows a rendered report in DotMatrix mode. If the report is not rendered then its rendering starts. |
| ShowDotMatrixWithRibbonGUI (+4 overloads) | StiReport | |
| ShowDotMatrixWithWpf (+1 overloads) | StiReport | Shows a rendered report in DotMatrix mode with using WPF technology. If the report is not rendered then its rendering starts. |
| ShowWithRibbonGUI (+4 overloads) | StiReport | Shows a rendered report in viewer with Ribbon GUI. If the report is not rendered then its rendering starts. |
| ShowWithWpf (+3 overloads) | StiReport | Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts. |
| ShowWithWpfRibbonGUI (+3 overloads) | StiReport | Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts. |
Method Details
CheckNeedForceInterpretationMode static
CheckNeedForceInterpretationMode(): bool
Returns bool
Compile
Compile(outputType: StiOutputType): StiReport
Compiles a report.
Parameters
- outputType (StiOutputType) — A parameter which sets a type of the output object.
Returns StiReport
Compile(path: string): StiReport
Compiles a report.
Parameters
- path (string) — A path for the report location.
Returns StiReport
Compile(): StiReport
Compiles a report.
Returns StiReport
Compile(path: string, outputType: StiOutputType): StiReport
Compiles a report and locates it to the specified path.
Parameters
- path (string) — A path for the report location.
- outputType (StiOutputType) — A parameter which sets the type of the output object.
Returns StiReport
Compile(stream: Stream): StiReport
Compiles a report and locates it in the specified stream.
Parameters
- stream (Stream) — A stream for the report location.
Returns StiReport
Compile(path: string, outputType: StiOutputType, autoCreate: bool, leaveScript: bool): StiReport
Compiles a report and locates it in the specified path.
Parameters
- path (string) — A parameter which sets the location of the compiled report.
- outputType (StiOutputType) — A parameter which sets the type of the output object.
- autoCreate (bool) — If true then the compiled report will be created.
- leaveScript (bool)
Returns StiReport
CompileAsync
CompileAsync(outputType: StiOutputType): Task<StiReport>
Compiles a report.
Parameters
- outputType (StiOutputType) — A parameter which sets a type of the output object.
Returns Task<StiReport>
CompileAsync(path: string): Task<StiReport>
Compiles a report.
Parameters
- path (string) — A path for the report location.
Returns Task<StiReport>
CompileAsync(): Task<StiReport>
Compiles a report.
Returns Task<StiReport>
CompileAsync(path: string, outputType: StiOutputType): Task<StiReport>
Compiles a report and locates it to the specified path.
Parameters
- path (string) — A path for the report location.
- outputType (StiOutputType) — A parameter which sets the type of the output object.
Returns Task<StiReport>
CompileAsync(stream: Stream): Task<StiReport>
Compiles a report and locates it in the specified stream.
Parameters
- stream (Stream) — A stream for the report location.
Returns Task<StiReport>
CompileAsync(path: string, outputType: StiOutputType, autoCreate: bool): Task<StiReport>
Compiles a report and locates it in the specified path.
Parameters
- path (string) — A parameter which sets the location of the compiled report.
- outputType (StiOutputType) — A parameter which sets the type of the output object.
- autoCreate (bool) — If true then the compiled report will be created.
Returns Task<StiReport>
CompileReportsToAssembly
CompileReportsToAssembly(assemblyPath: string, **: StiReportreports): CompilerResults
Parameters
- assemblyPath (string)
- ** (StiReportreports)
Returns CompilerResults
CompileReportsToAssembly(assemblyPath: string, **: StiReportreports, **languageType: StiReportLanguageType): CompilerResults
Parameters
- assemblyPath (string)
- ** (StiReportreports)
- languageType (StiReportLanguageType)
Returns CompilerResults
CompileReportsToAssemblyAsync
CompileReportsToAssemblyAsync(assemblyPath: string, **: StiReportreports): Task<StiReport>
Parameters
- assemblyPath (string)
- ** (StiReportreports)
Returns Task<StiReport>
CompileReportsToAssemblyAsync(assemblyPath: string, **: StiReportreports, **languageType: StiReportLanguageType): Task<StiReport>
Parameters
- assemblyPath (string)
- ** (StiReportreports)
- languageType (StiReportLanguageType)
Returns Task<StiReport>
CompileStandaloneReport
CompileStandaloneReport(path: string, standaloneReportType: StiStandaloneReportType): StiReport
Compiles a standalone report and locates it in the specified path.
Parameters
- path (string) — Path for the report location.
- standaloneReportType (StiStandaloneReportType)
Returns StiReport
CompileStandaloneReportAsync
CompileStandaloneReportAsync(path: string, standaloneReportType: StiStandaloneReportType): Task<StiReport>
Compiles a standalone report and locates it in the specified path.
Parameters
- path (string) — Path for the report location.
- standaloneReportType (StiStandaloneReportType)
Returns Task<StiReport>
CreateInstance
CreateInstance(path: string): StiReport
Parameters
- path (string)
Returns StiReport
CreateNewDashboard static
CreateNewDashboard(): StiReport
Returns StiReport
CreateNewForm static
CreateNewForm(): StiReport
Returns StiReport
CreateNewReport static
CreateNewReport(): StiReport
Returns StiReport
CreateNewScreen static
CreateNewScreen(): StiReport
Returns StiReport
Design
Design(): DialogResult
Calls the designer for the report in the Modal window.
Returns DialogResult
Design(dialogForm: bool): DialogResult
Calls the designer for the report.
Parameters
- dialogForm (bool) — Is this window a dialog box or not.
Returns DialogResult
Design(dialogForm: bool, win32Window: IWin32Window): DialogResult
Calls the designer for the report.
Parameters
- dialogForm (bool) — Is this window a dialog box or not.
- win32Window (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
Returns DialogResult
Design(parentForm: Form): DialogResult
Calls the designer for the report in the Parent Form.
Parameters
- parentForm (Form) — Parent Form.
Returns DialogResult
Design(owner: IWin32Window): DialogResult
Calls the designer for the report.
Parameters
- owner (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
Returns DialogResult
Design(owner: IWin32Window, dialogForm: bool): DialogResult
Calls the designer for the report.
Parameters
- owner (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
- dialogForm (bool) — Is this window a dialog box or not.
Returns DialogResult
DesignV2WithWpf
DesignV2WithWpf(): bool
Calls the designer for the report in the Modal window with using WPF technology.
Returns bool
DesignV2WithWpf(ownerWindow: object): bool
Calls the designer for the report in the Modal window with using WPF technology.
Parameters
- ownerWindow (object)
Returns bool
DesignV2WithWpf(dialogWindow: bool): bool
Calls the designer for the report in the Modal window with using WPF technology.
Parameters
- dialogWindow (bool)
Returns bool
DesignV2WithWpf(ownerWindow: object, dialogWindow: bool): bool
Calls the designer for the report in the Modal window with using WPF technology.
Parameters
- ownerWindow (object)
- dialogWindow (bool)
Returns bool
DesignWithWpf
DesignWithWpf(): bool
Calls the designer for the report in the Modal window with using WPF technology.
Returns bool
DesignWithWpf(dialogWindow: bool): bool
Parameters
- dialogWindow (bool)
Returns bool
DesignWithWpf(ownerWindow: object, dialogWindow: bool): bool
Parameters
- ownerWindow (object)
- dialogWindow (bool)
Returns bool
Div static
Div(value1: long, value2: long): long
Parameters
- value1 (long)
- value2 (long)
Returns long
Div(value1: long, value2: long, zeroResult: long): long
Parameters
- value1 (long)
- value2 (long)
- zeroResult (long)
Returns long
Div(value1: double, value2: double): double
Parameters
- value1 (double)
- value2 (double)
Returns double
Div(value1: double, value2: double, zeroResult: double): double
Parameters
- value1 (double)
- value2 (double)
- zeroResult (double)
Returns double
Div(value1: decimal, value2: decimal): decimal
Parameters
- value1 (decimal)
- value2 (decimal)
Returns decimal
Div(value1: decimal, value2: decimal, zeroResult: decimal): decimal
Parameters
- value1 (decimal)
- value2 (decimal)
- zeroResult (decimal)
Returns decimal
ExportDocument
ExportDocument(service: StiExportService, path: string): StiReport
Exports a rendered report into a file with dialog using the provider.
Parameters
- service (StiExportService) — A provider that exports a rendered report.
- path (string) — A file to export the rendered report.
Returns StiReport
ExportDocument(service: StiExportService, path: string, sendEMail: bool): StiReport
Exports a rendered report into a file with dialog using the provider.
Parameters
- service (StiExportService) — A provider that exports a rendered report.
- path (string) — A file to export the rendered report.
- sendEMail (bool) — If this parameter is true then the exported report will be sent via email.
Returns StiReport
ExportDocument(exportFormat: StiExportFormat, file: string): StiReport
Exports a rendered report into the file without dialog using the provider.
Parameters
- exportFormat (StiExportFormat) — A format for the document which will be exported to.
- file (string) — A file to export the rendered report.
Returns StiReport
ExportDocument(exportFormat: StiExportFormat, file: string, settings: StiExportSettings): StiReport
Exports a rendered report into the file without dialog using the provider.
Parameters
- exportFormat (StiExportFormat) — A format for the document which will be exported to.
- file (string) — A file to export the rendered report.
- settings (StiExportSettings)
Returns StiReport
ExportDocument(exportFormat: StiExportFormat, stream: Stream): StiReport
Exports a rendered report into the stream without dialog using the provider.
Parameters
- exportFormat (StiExportFormat) — A format for the document which will be exported to.
- stream (Stream) — A file to export the rendered report.
Returns StiReport
ExportDocument(exportFormat: StiExportFormat, stream: Stream, settings: StiExportSettings): StiReport
Exports a rendered report into the stream without dialog using the provider.
Parameters
- exportFormat (StiExportFormat) — A format for the document which will be exported to.
- stream (Stream) — A file to export the rendered report.
- settings (StiExportSettings)
Returns StiReport
ExportDocument(exportFormat: StiExportFormat, exportService: StiExportService, stream: Stream, settings: StiExportSettings): StiReport
Internal use only.
Parameters
- exportFormat (StiExportFormat)
- exportService (StiExportService)
- stream (Stream)
- settings (StiExportSettings)
Returns StiReport
ExportDocumentAsync
ExportDocumentAsync(service: StiExportService, path: string): Task<StiReport>
Exports a rendered report into a file with dialog using the provider.
Parameters
- service (StiExportService) — A provider that exports a rendered report.
- path (string) — A file to export the rendered report.
Returns Task<StiReport>
ExportDocumentAsync(service: StiExportService, path: string, sendEMail: bool): Task<StiReport>
Exports a rendered report into a file with dialog using the provider.
Parameters
- service (StiExportService) — A provider that exports a rendered report.
- path (string) — A file to export the rendered report.
- sendEMail (bool) — If this parameter is true then the exported report will be sent via email.
Returns Task<StiReport>
ExportDocumentAsync(exportFormat: StiExportFormat, file: string): Task<StiReport>
Exports a rendered report into the file without dialog using the provider.
Parameters
- exportFormat (StiExportFormat) — A format for the document which will be exported to.
- file (string) — A file to export the rendered report.
Returns Task<StiReport>
ExportDocumentAsync(exportFormat: StiExportFormat, file: string, settings: StiExportSettings): Task<StiReport>
Exports a rendered report into the file without dialog using the provider.
Parameters
- exportFormat (StiExportFormat) — A format for the document which will be exported to.
- file (string) — A file to export the rendered report.
- settings (StiExportSettings)
Returns Task<StiReport>
ExportDocumentAsync(exportFormat: StiExportFormat, stream: Stream): Task<StiReport>
Exports a rendered report into the stream without dialog using the provider.
Parameters
- exportFormat (StiExportFormat) — A format for the document which will be exported to.
- stream (Stream) — A file to export the rendered report.
Returns Task<StiReport>
ExportDocumentAsync(exportFormat: StiExportFormat, stream: Stream, settings: StiExportSettings): Task<StiReport>
Exports a rendered report into the stream without dialog using the provider.
Parameters
- exportFormat (StiExportFormat) — A format for the document which will be exported to.
- stream (Stream) — A file to export the rendered report.
- settings (StiExportSettings)
Returns Task<StiReport>
Format
Format(format: string, arg: object): string
Parameters
- format (string)
- arg (object)
Returns string
GetFontResourceName
GetFontResourceName(fontName: string): string
Parameters
- fontName (string)
Returns string
GetLabel
GetLabel(variableName: string): string
Parameters
- variableName (string)
Returns string
GetParam
GetParam(paramName: string): object
Parameters
- paramName (string)
Returns object
GetReportFromAssembly static
GetReportFromAssembly(assembly: Assembly): StiReport
Returns a created report from assembly.
Parameters
- assembly (Assembly) — Assembly with a report.
Returns StiReport — Created report.
GetReportFromAssembly(assemblyFile: string): StiReport
Returns a created report from assembly.
Parameters
- assemblyFile (string) — The path to assembly.
Returns StiReport — Created report.
GetReportFromAssembly(assemblyFile: string, lockFile: bool): StiReport
Returns a created report from assembly.
Parameters
- assemblyFile (string) — The path to assembly.
- lockFile (bool) — If true then file with assembly is locked but assembly is loaded to memory only once.
Returns StiReport — Created report.
GetReportFromAssembly(assemblyStream: Stream): StiReport
Returns a created report from assembly.
Parameters
- assemblyStream (Stream) — The stream with assembly.
Returns StiReport — Created report.
GetReportFromAssembly(**: bytebytes): StiReport
Returns a created report from the byte array.
Parameters
- ** (bytebytes)
Returns StiReport — Created report.
GetReportsFromAssembly static
GetReportsFromAssembly(assembly: Assembly): StiReport[]
Returns the array of rendered reports from assembly.
Parameters
- assembly (Assembly) — Assembly with reports.
Returns StiReport[] — The array of created reports.
GetResourceFontName
GetResourceFontName(resourceName: string): string
Parameters
- resourceName (string)
Returns string
GetResourceFontNames
GetResourceFontNames(resourceName: string): List
Parameters
- resourceName (string)
Returns List
IIF
IIF(condition: bool, value1: object, value2: object): object
Parameters
- condition (bool)
- value1 (object)
- value2 (object)
Returns object
IsEncryptedFile static
IsEncryptedFile(stream: Stream): bool
Returns true if specified stream contains encrypted report.
Parameters
- stream (Stream)
Returns bool
IsEncryptedFile(fileName: string): bool
Returns true if a file with the specified name contains encrypted report.
Parameters
- fileName (string)
Returns bool
IsEncryptedFile(**: bytebytes): bool
Parameters
- ** (bytebytes)
Returns bool
IsJsonFile static
IsJsonFile(fileName: string): bool
Returns a value indicating whether the specified file contains a JSON report.
Parameters
- fileName (string)
Returns bool
IsJsonFile(stream: Stream): bool
Returns true if specified stream contains JSON report.
Parameters
- stream (Stream)
Returns bool
IsNull
IsNull(dataSource: object, dataColumn: string): bool
Parameters
- dataSource (object)
- dataColumn (string)
Returns bool
IsPackedFile static
IsPackedFile(fileName: string): bool
Returns a value indicating whether the specified file contains a packed report.
Parameters
- fileName (string)
Returns bool
IsPackedFile(stream: Stream): bool
Returns true if specified stream contains packed report.
Parameters
- stream (Stream)
Returns bool
IsPackedFile(**: bytebytes): bool
Returns a value indicating whether the specified byte array contains a packed report.
Parameters
- ** (bytebytes)
Returns bool
LastOnPage
LastOnPage(dataSource: object, dataColumn: string): object
Parameters
- dataSource (object)
- dataColumn (string)
Returns object
Load
Load(name: AssemblyName): Assembly
Parameters
- name (AssemblyName)
Returns Assembly
Load(stream: Stream): StiReport
Loads a report template from the stream.
Parameters
- stream (Stream) — A stream for loading a report template.
Returns StiReport
Load(**: bytebytes): StiReport
Loads a report template from the byte array.
Parameters
- ** (bytebytes)
Returns StiReport
Load(path: string): StiReport
Loads a report template from the file.
Parameters
- path (string) — A file which contains the report template.
Returns StiReport
Load(service: StiReportSLService, stream: Stream): StiReport
Loads a report template from the stream using provider.
Parameters
- service (StiReportSLService) — A provider which loads a report template.
- stream (Stream) — A stream for loading a report template.
Returns StiReport
Load(service: StiReportSLService, path: string): StiReport
Loads a report template from the file using the provider.
Parameters
- service (StiReportSLService) — A provider which loads a report template.
- path (string) — A file for loading a report template.
Returns StiReport
LoadAsync
LoadAsync(stream: Stream): Task<StiReport>
Loads asynchronously a report template from the stream.
Parameters
- stream (Stream) — A stream for loading a report template.
Returns Task<StiReport>
LoadAsync(**: bytebytes): Task<StiReport>
Loads asynchronously a report template from the byte array.
Parameters
- ** (bytebytes)
Returns Task<StiReport>
LoadAsync(path: string): Task<StiReport>
Loads asynchronously a report template from the file.
Parameters
- path (string) — A file which contains the report template.
Returns Task<StiReport>
LoadAsync(service: StiReportSLService, stream: Stream): Task<StiReport>
Loads asynchronously a report template from the stream using provider.
Parameters
- service (StiReportSLService) — A provider which loads a report template.
- stream (Stream) — A stream for loading a report template.
Returns Task<StiReport>
LoadAsync(service: StiReportSLService, path: string): Task<StiReport>
Loads asynchronously a report template from the file using the provider.
Parameters
- service (StiReportSLService) — A provider which loads a report template.
- path (string) — A file for loading a report template.
Returns Task<StiReport>
LoadDocument
LoadDocument(**: bytebytes): StiReport
Loads a rendered report from the byte array.
Parameters
- ** (bytebytes)
Returns StiReport
LoadDocument(stream: Stream): StiReport
Loads a rendered report from the stream.
Parameters
- stream (Stream) — A stream for loading a rendered report.
Returns StiReport
LoadDocument(path: string): StiReport
Loads a rendered report from the file.
Parameters
- path (string) — A file which contains a rendered report.
Returns StiReport
LoadDocument(service: StiDocumentSLService, stream: Stream): StiReport
Loads a rendered report from the stream using the provider.
Parameters
- service (StiDocumentSLService) — A provider for loading a rendered report.
- stream (Stream) — A stream for loading a rendered report.
Returns StiReport
LoadDocument(service: StiDocumentSLService, path: string): StiReport
Loads a rendered report from the file using the provider.
Parameters
- service (StiDocumentSLService) — A provider for loading a rendered report.
- path (string) — A file for loading a rendered report.
Returns StiReport
LoadDocumentAsync
LoadDocumentAsync(**: bytebytes): Task<StiReport>
Loads asynchronously a rendered report from the byte array.
Parameters
- ** (bytebytes)
Returns Task<StiReport>
LoadDocumentAsync(stream: Stream): Task<StiReport>
Loads asynchronously a rendered report from the stream.
Parameters
- stream (Stream) — A stream for loading a rendered report.
Returns Task<StiReport>
LoadDocumentAsync(path: string): Task<StiReport>
Loads asynchronously a rendered report from the file.
Parameters
- path (string) — A file which contains a rendered report.
Returns Task<StiReport>
LoadDocumentAsync(service: StiDocumentSLService, stream: Stream): Task<StiReport>
Loads asynchronously a rendered report from the stream using the provider.
Parameters
- service (StiDocumentSLService) — A provider for loading a rendered report.
- stream (Stream) — A stream for loading a rendered report.
Returns Task<StiReport>
LoadDocumentAsync(service: StiDocumentSLService, path: string): Task<StiReport>
Loads asynchronously a rendered report from the file using the provider.
Parameters
- service (StiDocumentSLService) — A provider for loading a rendered report.
- path (string) — A file for loading a rendered report.
Returns Task<StiReport>
LoadDocumentFonts
LoadDocumentFonts(): StiReport
Returns StiReport
LoadDocumentFromJson
LoadDocumentFromJson(json: string): StiReport
Loads a rendered report from the string.
Parameters
- json (string) — A string for loading a report from it.
Returns StiReport
LoadDocumentFromJson(stream: Stream): StiReport
Loads a rendered report from the stream.
Parameters
- stream (Stream) — A stream for loading a report template.
Returns StiReport
LoadDocumentFromJsonAsync
LoadDocumentFromJsonAsync(json: string): Task<StiReport>
Loads asynchronously a rendered report from the JSON string.
Parameters
- json (string) — A string for loading a report from it.
Returns Task<StiReport>
LoadDocumentFromJsonAsync(stream: Stream): Task<StiReport>
Loads asynchronously a JSON rendered report from the stream.
Parameters
- stream (Stream) — A stream for loading a report template.
Returns Task<StiReport>
LoadDocumentFromString
LoadDocumentFromString(reportStr: string): StiReport
Loads a rendered report from the string.
Parameters
- reportStr (string) — A string for loading a report from it.
Returns StiReport
LoadDocumentFromStringAsync
LoadDocumentFromStringAsync(reportStr: string): Task<StiReport>
Loads asynchronously a rendered report from the string.
Parameters
- reportStr (string) — A string for loading a report from it.
Returns Task<StiReport>
LoadDocumentFromUrl
LoadDocumentFromUrl(url: string, headers: NameValueCollection): StiReport
Loads a rendered report template from specified url.
Parameters
- url (string) — Url which will be used for report loading.
- headers (NameValueCollection)
Returns StiReport
LoadDocumentFromUrlAsync
LoadDocumentFromUrlAsync(url: string, headers: NameValueCollection): Task<StiReport>
Loads asynchronously a rendered report template from specified url.
Parameters
- url (string) — Url which will be used for report loading.
- headers (NameValueCollection)
Returns Task<StiReport>
LoadEditableFields
LoadEditableFields(path: string): StiReport
Loads the editable fields of rendered report from the stream.
Parameters
- path (string)
Returns StiReport
LoadEditableFields(stream: Stream): StiReport
Loads the editable fields of rendered report from the stream.
Parameters
- stream (Stream) — Stream for loading the editable fields.
Returns StiReport
LoadEncryptedDocument
LoadEncryptedDocument(stream: Stream, key: string): StiReport
Loads an encrypted rendered report from the stream.
Parameters
- stream (Stream) — The stream to load an encrypted rendered report.
- key (string) — The key for encryption.
Returns StiReport
LoadEncryptedDocument(path: string, key: string): StiReport
Loads an encrypted rendered report from the file.
Parameters
- path (string) — The file which contains an encrypted rendered report.
- key (string) — The key for encryption.
Returns StiReport
LoadEncryptedDocument(**: bytebytes, **key: string): StiReport
Loads an encrypted rendered report from the byte array.
Parameters
- ** (bytebytes)
- key (string) — The key for encryption.
Returns StiReport
LoadEncryptedDocumentAsync
LoadEncryptedDocumentAsync(stream: Stream, key: string): Task<StiReport>
Loads asynchronously an encrypted rendered report from the stream.
Parameters
- stream (Stream) — The stream to load an encrypted rendered report.
- key (string) — The key for encryption.
Returns Task<StiReport>
LoadEncryptedDocumentAsync(path: string, key: string): Task<StiReport>
Loads asynchronously an encrypted rendered report from the file.
Parameters
- path (string) — The file which contains an encrypted rendered report.
- key (string) — The key for encryption.
Returns Task<StiReport>
LoadEncryptedDocumentAsync(**: bytebytes, **key: string): Task<StiReport>
Loads asynchronously an encrypted rendered report from the byte array.
Parameters
- ** (bytebytes)
- key (string) — The key for encryption.
Returns Task<StiReport>
LoadEncryptedDocumentFromString
LoadEncryptedDocumentFromString(reportStr: string, key: string): StiReport
Loads an encrypted rendered report from the string.
Parameters
- reportStr (string) — A string from which the encrypted rendered report will be loaded from.
- key (string) — The key for encryption.
Returns StiReport
LoadEncryptedDocumentFromStringAsync
LoadEncryptedDocumentFromStringAsync(reportStr: string, key: string): Task<StiReport>
Loads asynchronously an encrypted rendered report from the string.
Parameters
- reportStr (string) — A string from which the encrypted rendered report will be loaded from.
- key (string) — The key for encryption.
Returns Task<StiReport>
LoadEncryptedReport
LoadEncryptedReport(stream: Stream, key: string): StiReport
Loads an encrypted report template from the stream.
Parameters
- stream (Stream) — A stream to load an encrypted report template.
- key (string) — The key for encryption.
Returns StiReport
LoadEncryptedReport(path: string, key: string): StiReport
Loads an encrypted report template from the file.
Parameters
- path (string) — A file which contains an encrypted report template.
- key (string) — The key for encryption.
Returns StiReport
LoadEncryptedReport(**: bytebytes, **key: string): StiReport
Loads an encrypted report template from the byte array.
Parameters
- ** (bytebytes)
- key (string) — The key for encryption.
Returns StiReport
LoadEncryptedReportAsync
LoadEncryptedReportAsync(stream: Stream, key: string): Task<StiReport>
Loads asynchronously an encrypted report template from the stream.
Parameters
- stream (Stream) — A stream to load an encrypted report template.
- key (string) — The key for encryption.
Returns Task<StiReport>
LoadEncryptedReportAsync(path: string, key: string): Task<StiReport>
Loads asynchronically an encrypted report template from the file.
Parameters
- path (string) — A file which contains an encrypted report template.
- key (string) — The key for encryption.
Returns Task<StiReport>
LoadEncryptedReportAsync(**: bytebytes, **key: string): Task<StiReport>
Loads asynchronously an encrypted report template from the byte array.
Parameters
- ** (bytebytes)
- key (string) — The key for encryption.
Returns Task<StiReport>
LoadEncryptedReportFromString
LoadEncryptedReportFromString(reportStr: string, key: string): StiReport
Loads an encrypted report template from the string.
Parameters
- reportStr (string) — A string which contains the encrypted template.
- key (string) — The key for encryption.
Returns StiReport
LoadEncryptedReportFromStringAsync
LoadEncryptedReportFromStringAsync(reportStr: string, key: string): Task<StiReport>
Loads asynchronously an encrypted report template from the string.
Parameters
- reportStr (string) — A string which contains the encrypted template.
- key (string) — The key for encryption.
Returns Task<StiReport>
LoadFonts
LoadFonts(): StiReport
Returns StiReport
LoadFromJson
LoadFromJson(json: string): StiReport
Loads a report template from the string.
Parameters
- json (string) — A string which contains the report template.
Returns StiReport
LoadFromJson(stream: Stream): StiReport
Loads a report template from the stream.
Parameters
- stream (Stream) — A stream for loading a report template.
Returns StiReport
LoadFromJsonAsync
LoadFromJsonAsync(json: string): Task<StiReport>
Loads asynchronously a report template from the string.
Parameters
- json (string) — A string which contains the report template.
Returns Task<StiReport>
LoadFromJsonAsync(stream: Stream): Task<StiReport>
Loads asynchronously a report template from the stream.
Parameters
- stream (Stream) — A stream for loading a report template.
Returns Task<StiReport>
LoadFromString
LoadFromString(reportStr: string): StiReport
Loads a report template from the string.
Parameters
- reportStr (string) — A string which contains the report template.
Returns StiReport
LoadFromStringAsync
LoadFromStringAsync(reportStr: string): Task<StiReport>
Loads asynchronously a report template from the string.
Parameters
- reportStr (string) — A string which contains the report template.
Returns Task<StiReport>
LoadFromUrl
LoadFromUrl(url: string, headers: NameValueCollection): StiReport
Loads a report template from specified url.
Parameters
- url (string) — Url which will be used for report loading.
- headers (NameValueCollection)
Returns StiReport
LoadFromUrlAsync
LoadFromUrlAsync(url: string, headers: NameValueCollection): Task<StiReport>
Loads asynchronously a report template from specified url.
Parameters
- url (string) — Url which will be used for report loading.
- headers (NameValueCollection)
Returns Task<StiReport>
LoadPackedDocument
LoadPackedDocument(stream: Stream): StiReport
Loads a packed rendered report from the stream.
Parameters
- stream (Stream) — The stream to load a packed rendered report.
Returns StiReport
LoadPackedDocument(path: string): StiReport
Loads a packed rendered report from the file.
Parameters
- path (string) — The file which contains a packed rendered report.
Returns StiReport
LoadPackedDocument(**: bytebytes): StiReport
Loads a packed rendered report from the byte array.
Parameters
- ** (bytebytes)
Returns StiReport
LoadPackedDocumentAsync
LoadPackedDocumentAsync(stream: Stream): Task<StiReport>
Loads asynchronously a packed rendered report from the stream.
Parameters
- stream (Stream) — The stream to load a packed rendered report.
Returns Task<StiReport>
LoadPackedDocumentAsync(path: string): Task<StiReport>
Loads asynchronously a packed rendered report from the file.
Parameters
- path (string) — The file which contains a packed rendered report.
Returns Task<StiReport>
LoadPackedDocumentAsync(**: bytebytes): Task<StiReport>
Loads asynchronously a packed rendered report from the byte array.
Parameters
- ** (bytebytes)
Returns Task<StiReport>
LoadPackedDocumentFromString
LoadPackedDocumentFromString(reportStr: string): StiReport
Loads a packed rendered report from the string.
Parameters
- reportStr (string) — A string from which the packed rendered report will be loaded from.
Returns StiReport
LoadPackedDocumentFromStringAsync
LoadPackedDocumentFromStringAsync(reportStr: string): Task<StiReport>
Loads asynchronously a packed rendered report from the string.
Parameters
- reportStr (string) — A string from which the packed rendered report will be loaded from.
Returns Task<StiReport>
LoadPackedReport
LoadPackedReport(stream: Stream): StiReport
Loads a packed report template from the stream.
Parameters
- stream (Stream) — A stream to load a packed report template.
Returns StiReport
LoadPackedReport(path: string): StiReport
Loads a packed report template from the file.
Parameters
- path (string) — A file which contains a packed report template.
Returns StiReport
LoadPackedReport(**: bytebytes): StiReport
Loads a packed report template from the byte array.
Parameters
- ** (bytebytes)
Returns StiReport
LoadPackedReportAsync
LoadPackedReportAsync(stream: Stream): Task<StiReport>
Loads asynchronously a packed report template from the stream.
Parameters
- stream (Stream) — A stream to load a packed report template.
Returns Task<StiReport>
LoadPackedReportAsync(path: string): Task<StiReport>
Loads asynchronously a packed report template from the file.
Parameters
- path (string) — A file which contains a packed report template.
Returns Task<StiReport>
LoadPackedReportAsync(**: bytebytes): Task<StiReport>
Loads asynchronously a packed report template from the byte array.
Parameters
- ** (bytebytes)
Returns Task<StiReport>
LoadPackedReportFromString
LoadPackedReportFromString(reportStr: string): StiReport
Loads a packed report template from the string.
Parameters
- reportStr (string) — A string which contains the report template.
Returns StiReport
LoadPackedReportFromStringAsync
LoadPackedReportFromStringAsync(reportStr: string): Task<StiReport>
Loads asynchronously a packed report template from the string.
Parameters
- reportStr (string) — A string which contains the report template.
Returns Task<StiReport>
LoadReportFromResource
LoadReportFromResource(reportAssembly: Assembly, reportResource: string): StiReport
Loads a report template from the resource.
Parameters
- reportAssembly (Assembly) — Assembly in which is the report is placed.
- reportResource (string) — A name of resources which contains a report template.
Returns StiReport
LoadReportFromResource(assemblyName: string, reportResource: string): StiReport
Loads a report template from the resource.
Parameters
- assemblyName (string) — The name of assembly in which the report is placed.
- reportResource (string) — A name of resources which contains a report template.
Returns StiReport
LoadReportFromResourceAsync
LoadReportFromResourceAsync(reportAssembly: Assembly, reportResource: string): Task<StiReport>
Loads asynchronously a report template from the resource.
Parameters
- reportAssembly (Assembly) — Assembly in which is the report is placed.
- reportResource (string) — A name of resources which contains a report template.
Returns Task<StiReport>
LoadReportFromResourceAsync(assemblyName: string, reportResource: string): Task<StiReport>
Loads asynchronously a report template from the resource.
Parameters
- assemblyName (string) — The name of assembly in which the report is placed.
- reportResource (string) — A name of resources which contains a report template.
Returns Task<StiReport>
LocalizeReport
LocalizeReport(cultureName: string): StiReport
Localize a report to the specified culture name. The culture definition must be placed in GlobalizationStrings.
Parameters
- cultureName (string)
Returns StiReport
LocalizeReport(info: CultureInfo): StiReport
Localize a report to the specified culture. The culture definition must be placed in GlobalizationStrings.
Parameters
- info (CultureInfo)
Returns StiReport
MergeDocument
MergeDocument(report: StiReport, needRendering: bool): void
Merge a document to the current document.
Parameters
- report (StiReport)
- needRendering (bool)
NextIsNull
NextIsNull(dataSource: object, dataColumn: string): bool
Parameters
- dataSource (object)
- dataColumn (string)
Returns bool
PreviousIsNull
PreviousIsNull(dataSource: object, dataColumn: string): bool
Parameters
- dataSource (object)
- dataColumn (string)
Returns bool
Print(printerSettings: PrinterSettings): StiReport
Prints the rendered report without print dialog. If the report is not rendered then its rendering starts.
Parameters
- printerSettings (PrinterSettings) — Specifies information about how a document is printed, including the printer that prints it.
Returns StiReport
Print(showPrintDialog: bool, printerSettings: PrinterSettings): StiReport
Prints the rendered report. If the report is not rendered then its rendering starts.
Parameters
- showPrintDialog (bool) — If a parameter is true then the print dialog will be shown.
- printerSettings (PrinterSettings) — Specifies information about how a document is printed, including the printer that prints it.
Returns StiReport
Print(): StiReport
Prints the rendered report. If the report is not rendered then its rendering starts.
Returns StiReport
Print(fromPage: int, toPage: int, copies: short): StiReport
Prints the rendered report with the print dialog. If the report is not rendered then its rendering starts.
Parameters
- fromPage (int) — A number of the first page to print.
- toPage (int) — A number of the last page to print.
- copies (short) — A number of copies to print.
Returns StiReport
Print(showPrintDialog: bool, copies: short): StiReport
Prints a rendered report. If the report is not rendered then its rendering starts.
Parameters
- showPrintDialog (bool) — If a parameter is true then the print dialog will be shown.
- copies (short) — A number of copies to print.
Returns StiReport
Print(showPrintDialog: bool): StiReport
Prints the rendered report. If the report is not rendered then its rendering starts.
Parameters
- showPrintDialog (bool) — If a parameter is true then the print dialog will be shown.
Returns StiReport
Print(showPrintDialog: bool, fromPage: int, toPage: int, copies: short): StiReport
Prints the rendered report. If the report is not rendered then its rendering starts.
Parameters
- showPrintDialog (bool) — If a parameter is true then the print dialog will be shown.
- fromPage (int) — A number of the first page to print.
- toPage (int) — A number of the last page to print.
- copies (short) — A number of copies to print.
Returns StiReport
Print(showPrintDialog: bool, fromPage: int, toPage: int, copies: short, printerSettings: PrinterSettings, printProvider: StiPrintProvider): StiReport
Prints the rendered report. If the report is not rendered then its rendering starts.
Parameters
- showPrintDialog (bool) — If a parameter is true then the print dialog will be shown.
- fromPage (int) — A number of the first page to print.
- toPage (int) — A number of the last page to print.
- copies (short) — A number of copies to print.
- printerSettings (PrinterSettings) — Specifies information about how a document is printed, including the printer that prints it.
- printProvider (StiPrintProvider)
Returns StiReport
PrintAsync
PrintAsync(printerSettings: PrinterSettings): Task<StiReport>
Prints the rendered report. If the report is not rendered then its rendering starts.
Parameters
- printerSettings (PrinterSettings) — Specifies information about how a document is printed, including the printer that prints it.
Returns Task<StiReport>
PrintAsync(copies: short): Task<StiReport>
Prints the rendered report. If the report is not rendered then its rendering starts.
Parameters
- copies (short) — A number of copies to print.
Returns Task<StiReport>
PrintAsync(): Task<StiReport>
Prints the rendered report. If the report is not rendered then its rendering starts.
Returns Task<StiReport>
PrintAsync(fromPage: int, toPage: int, copies: short): Task<StiReport>
Prints the rendered report. If the report is not rendered then its rendering starts.
Parameters
- fromPage (int) — A number of the first page to print.
- toPage (int) — A number of the last page to print.
- copies (short) — A number of copies to print.
Returns Task<StiReport>
PrintAsync(fromPage: int, toPage: int, copies: short, printerSettings: PrinterSettings): Task<StiReport>
Prints the rendered report. If the report is not rendered then its rendering starts.
Parameters
- fromPage (int) — A number of the first page to print.
- toPage (int) — A number of the last page to print.
- copies (short) — A number of copies to print.
- printerSettings (PrinterSettings) — Specifies information about how a document is printed, including the printer that prints it.
Returns Task<StiReport>
PrintReports static
PrintReports(reports: List<StiReport>): void
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Parameters
- reports (List<StiReport>) — Collection of reports to print.
PrintReports(reports: List<StiReport>, showPrintDialog: bool, copies: short): void
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Parameters
- reports (List<StiReport>) — Collection of reports to print.
- showPrintDialog (bool) — If a parameter is true then the print dialog will be shown.
- copies (short) — A number of copies to print.
PrintReports(reports: List<StiReport>, showPrintDialog: bool, copies: short, printerSettings: PrinterSettings): void
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Parameters
- reports (List<StiReport>) — Collection of reports to print.
- showPrintDialog (bool) — If a parameter is true then the print dialog will be shown.
- copies (short) — A number of copies to print.
- printerSettings (PrinterSettings) — Specifies information about how a document is printed, including the printer that prints it.
PrintReportsAsync
PrintReportsAsync(reports: List<StiReport>): Task<StiReport>
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Parameters
- reports (List<StiReport>) — Collection of reports to print.
Returns Task<StiReport>
PrintReportsAsync(reports: List<StiReport>, copies: short): Task<StiReport>
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Parameters
- reports (List<StiReport>) — Collection of reports to print.
- copies (short) — A number of copies to print.
Returns Task<StiReport>
PrintReportsAsync(reports: List<StiReport>, copies: short, printerSettings: PrinterSettings): Task<StiReport>
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Parameters
- reports (List<StiReport>) — Collection of reports to print.
- copies (short) — A number of copies to print.
- printerSettings (PrinterSettings) — Specifies information about how a document is printed, including the printer that prints it.
Returns Task<StiReport>
PrintToDotMatrixPrinter
PrintToDotMatrixPrinter(): StiReport
Prints a report to default dot-matrix printer in the RAW mode in ASCII encoding.
Returns StiReport
PrintToDotMatrixPrinter(printerName: string): StiReport
Prints a report to dot-matrix printer in the RAW mode in ASCII encoding.
Parameters
- printerName (string) — A name of a printer.
Returns StiReport
PrintToDotMatrixPrinter(printerName: string, encoding: Encoding): StiReport
Prints report to dot-matrix printer in the RAW mode.
Parameters
- printerName (string) — A name of a printer.
- encoding (Encoding) — A parameter which sets text encoding.
Returns StiReport
PrintToDotMatrixPrinter(printerName: string, encoding: Encoding, fromPage: int, toPage: int): StiReport
Prints a report to dot-matrix printer in the RAW mode.
Parameters
- printerName (string) — A name of a printer.
- encoding (Encoding) — A parameter which sets text encoding.
- fromPage (int) — A number of the first page to print.
- toPage (int) — A number of the last page to print.
Returns StiReport
PrintWithWpf
PrintWithWpf(): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Returns StiReport
PrintWithWpf(printerName: string): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- printerName (string) — A name of a printer that will be used for printing.
Returns StiReport
PrintWithWpf(printTicket: object): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- printTicket (object) — Specifies information about how a document is printed.
Returns StiReport
PrintWithWpf(showPrintDialog: bool): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- showPrintDialog (bool) — Show the print dialog or no.
Returns StiReport
PrintWithWpf(printTicket: object, showPrintDialog: bool): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- printTicket (object) — Specifies information about how a document is printed.
- showPrintDialog (bool) — Show the print dialog or no.
Returns StiReport
PrintWithWpf(copies: int): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- copies (int) — Number of copies to print.
Returns StiReport
PrintWithWpf(showPrintDialog: bool, copies: int): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- showPrintDialog (bool) — Show the print dialog or no.
- copies (int) — Number of copies to print.
Returns StiReport
PrintWithWpf(showPrintDialog: bool, copies: int, printerName: string): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- showPrintDialog (bool) — Show the print dialog or no.
- copies (int) — Number of copies to print.
- printerName (string) — A name of a printer that will be used for printing.
Returns StiReport
PrintWithWpf(showPrintDialog: bool, fromPage: int, toPage: int, copies: int): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- showPrintDialog (bool) — Show the print dialog or no.
- fromPage (int) — Number of the first page to print. Starts from 1.
- toPage (int) — Number of the last page to print. Starts from 1.
- copies (int) — Number of copies to print.
Returns StiReport
PrintWithWpf(showPrintDialog: bool, fromPage: int, toPage: int, copies: int, printerName: string): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- showPrintDialog (bool) — Show the print dialog or no.
- fromPage (int) — Number of the first page to print. Starts from 1.
- toPage (int) — Number of the last page to print. Starts from 1.
- copies (int) — Number of copies to print.
- printerName (string) — A name of a printer that will be used for printing.
Returns StiReport
PrintWithWpf(printTicket: object, showPrintDialog: bool, fromPage: int, toPage: int, copies: int, printerName: string): StiReport
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- printTicket (object) — Specifies information about how a document is printed.
- showPrintDialog (bool) — Show the print dialog or no.
- fromPage (int) — Number of the first page to print. Starts from 1.
- toPage (int) — Number of the last page to print. Starts from 1.
- copies (int) — Number of copies to print.
- printerName (string) — A name of a printer that will be used for printing.
Returns StiReport
PrintWithWpfAsync
PrintWithWpfAsync(): Task<StiReport>
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Returns Task<StiReport>
PrintWithWpfAsync(printerName: string): Task<StiReport>
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- printerName (string) — A name of a printer that will be used for printing.
Returns Task<StiReport>
PrintWithWpfAsync(printTicket: object): Task<StiReport>
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- printTicket (object) — Specifies information about how a document is printed.
Returns Task<StiReport>
PrintWithWpfAsync(copies: int): Task<StiReport>
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- copies (int) — Number of copies to print.
Returns Task<StiReport>
PrintWithWpfAsync(copies: int, printerName: string): Task<StiReport>
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- copies (int) — Number of copies to print.
- printerName (string) — A name of a printer that will be used for printing.
Returns Task<StiReport>
PrintWithWpfAsync(fromPage: int, toPage: int, copies: int): Task<StiReport>
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- fromPage (int) — Number of the first page to print. Starts from 1.
- toPage (int) — Number of the last page to print. Starts from 1.
- copies (int) — Number of copies to print.
Returns Task<StiReport>
PrintWithWpfAsync(fromPage: int, toPage: int, copies: int, printerName: string): Task<StiReport>
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- fromPage (int) — Number of the first page to print. Starts from 1.
- toPage (int) — Number of the last page to print. Starts from 1.
- copies (int) — Number of copies to print.
- printerName (string) — A name of a printer that will be used for printing.
Returns Task<StiReport>
PrintWithWpfAsync(printTicket: object, fromPage: int, toPage: int, copies: int, printerName: string): Task<StiReport>
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Parameters
- printTicket (object) — Specifies information about how a document is printed.
- fromPage (int) — Number of the first page to print. Starts from 1.
- toPage (int) — Number of the last page to print. Starts from 1.
- copies (int) — Number of copies to print.
- printerName (string) — A name of a printer that will be used for printing.
Returns Task<StiReport>
PrintWithXbap
PrintWithXbap(): StiReport
Returns StiReport
PrintWithXbap(printerName: string): StiReport
Parameters
- printerName (string)
Returns StiReport
PrintWithXbap(printTicket: object): StiReport
Parameters
- printTicket (object)
Returns StiReport
PrintWithXbap(showPrintDialog: bool): StiReport
Parameters
- showPrintDialog (bool)
Returns StiReport
PrintWithXbap(printTicket: object, showPrintDialog: bool): StiReport
Parameters
- printTicket (object)
- showPrintDialog (bool)
Returns StiReport
PrintWithXbap(copies: int): StiReport
Parameters
- copies (int)
Returns StiReport
PrintWithXbap(showPrintDialog: bool, copies: int): StiReport
Parameters
- showPrintDialog (bool)
- copies (int)
Returns StiReport
PrintWithXbap(showPrintDialog: bool, copies: int, printerName: string): StiReport
Parameters
- showPrintDialog (bool)
- copies (int)
- printerName (string)
Returns StiReport
PrintWithXbap(showPrintDialog: bool, fromPage: int, toPage: int, copies: int): StiReport
Parameters
- showPrintDialog (bool)
- fromPage (int)
- toPage (int)
- copies (int)
Returns StiReport
PrintWithXbap(showPrintDialog: bool, fromPage: int, toPage: int, copies: int, printerName: string): StiReport
Parameters
- showPrintDialog (bool)
- fromPage (int)
- toPage (int)
- copies (int)
- printerName (string)
Returns StiReport
PrintWithXbap(printTicket: object, showPrintDialog: bool, fromPage: int, toPage: int, copies: int, printerName: string): StiReport
Parameters
- printTicket (object)
- showPrintDialog (bool)
- fromPage (int)
- toPage (int)
- copies (int)
- printerName (string)
Returns StiReport
RecalculateRenderedPagesSegments
RecalculateRenderedPagesSegments(): StiReport
Recalculate segments in all rendered pages
Returns StiReport
RegBusinessObject
RegBusinessObject(name: string, value: object, synchronize: bool): StiReport
Registers the business object in the report.
Parameters
- name (string) — Name of the registered business object.
- value (object) — Business object.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegBusinessObject(category: string, name: string, value: object, synchronize: bool): StiReport
Registers the business object in the report.
Parameters
- category (string) — Name of the category in which registered business object will be placed in report dictionary.
- name (string) — Name of the registered business object.
- value (object) — Business object.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegBusinessObject(category: string, name: string, alias: string, value: object, synchronize: bool): StiReport
Registers the business object in the report.
Parameters
- category (string) — Name of the category in which registered business object will be placed in report dictionary.
- name (string) — Name of the registered business object.
- alias (string) — Alias of the registered business object.
- value (object) — Business object.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegBusinessObject(businessObjects: List<StiBusinessObjectData>, synchronize: bool): StiReport
Registers list of business objects in business objects store of specified report.
Parameters
- businessObjects (List<StiBusinessObjectData>) — List of business objects.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegBusinessObjectAsync
RegBusinessObjectAsync(category: string, name: string, alias: string, value: object, synchronize: bool): Task<StiReport>
Asynchronously registers the business object in the report.
Parameters
- category (string) — Name of the category in which registered business object will be placed in report dictionary.
- name (string) — Name of the registered business object.
- alias (string) — Alias of the registered business object.
- value (object) — Business object.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegBusinessObjectAsync(businessObjects: List<StiBusinessObjectData>, synchronize: bool): Task<StiReport>
Asynchronously registers list of business objects in business objects store of specified report.
Parameters
- businessObjects (List<StiBusinessObjectData>) — List of business objects.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegCsvData
RegCsvData(name: string, **: bytedata, **synchronize: bool): StiDatabase
Registers a new connection to the CSV data file.
Parameters
- name (string) — A name of the CSV connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the CSV data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegCsvDataAsync
RegCsvDataAsync(name: string, **: bytedata, **synchronize: bool): Task
Asynchronously registers a new connection to the CSV data file.
Parameters
- name (string) — A name of the CSV connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the CSV data file will be created or updated in the Dictionary.
Returns Task
RegCsvFile
RegCsvFile(name: string, fileName: string, synchronize: bool): StiDatabase
Registers a new connection to the CSV data file.
Parameters
- name (string) — A name of the CSV connection in the dictionary.
- fileName (string) — A file path to the CSV data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the CSV data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegCsvFileAsync
RegCsvFileAsync(name: string, fileName: string, synchronize: bool): Task
Registers a new connection to the CSV data file.
Parameters
- name (string) — A name of the CSV connection in the dictionary.
- fileName (string) — A file path to the CSV data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the CSV data file will be created or updated in the Dictionary.
Returns Task
RegData
RegData(name: string, data: object, synchronize: bool): StiReport
Registers an object in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- data (object) — The object for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, dataTable: DataTable, synchronize: bool): StiReport
Registers an object in the Data Store.
Parameters
- name (string) — DataTable name in the Data Store.
- dataTable (DataTable) — DataTable for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(dataTable: DataTable, synchronize: bool): StiReport
Registers the DataTable in the Data Store.
Parameters
- dataTable (DataTable) — The DataTable for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, dataSet: DataSet, synchronize: bool): StiReport
Registers all Data-Tables and Data-Relations which are in the specified DataSet in the report.
Parameters
- name (string) — A name for the DataSet registration.
- dataSet (DataSet) — The DataSet for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(dataSet: DataSet, synchronize: bool): StiReport
Registers all DataTable and DataRelation which are in the specified DataSet in the Data Store.
Parameters
- dataSet (DataSet) — DataSet for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, dataView: DataView, synchronize: bool): StiReport
Registers DataView in the Data Store.
Parameters
- name (string) — DataView name in the Data Store.
- dataView (DataView) — DataView for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(dataView: DataView, synchronize: bool): StiReport
Registers DataView in the Data Store.
Parameters
- dataView (DataView) — DataView for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, connection: SqlConnection, synchronize: bool): StiReport
Registers SqlConnection in the Data Store.
Parameters
- name (string) — SqlConnection name in the Data Store.
- connection (SqlConnection) — SqlConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, connection: OleDbConnection, synchronize: bool): StiReport
Registers OleDbConnection in the Data Store.
Parameters
- name (string) — OleDbConnection name in the Data Store.
- connection (OleDbConnection) — OleDbConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, connection: OdbcConnection, synchronize: bool): StiReport
Registers OdbcConnection in the Data Store.
Parameters
- name (string) — OdbcConnection name in the Data Store.
- connection (OdbcConnection) — OdbcConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, alias: string, data: object, synchronize: bool): StiReport
Registers an object in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- data (object) — The object for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, alias: string, dataTable: DataTable, synchronize: bool): StiReport
Registers an object in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- dataTable (DataTable) — DataTable for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, alias: string, dataSet: DataSet, synchronize: bool): StiReport
Registers all DataTables and DataRelations which are in the specified DataSet in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- dataSet (DataSet) — DataSet for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, alias: string, dataView: DataView, synchronize: bool): StiReport
Registers DataView in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- dataView (DataView) — DataView for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, alias: string, connection: SqlConnection, synchronize: bool): StiReport
Registers SqlConnection in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- connection (SqlConnection) — SqlConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, alias: string, connection: OleDbConnection, synchronize: bool): StiReport
Registers OleDbConnection in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- connection (OleDbConnection) — OleDbConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(name: string, alias: string, connection: OdbcConnection, synchronize: bool): StiReport
Registers OdbcConnection in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- connection (OdbcConnection) — OdbcConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegData(datas: StiDataCollection, synchronize: bool): StiReport
Registers the DataCollection in the DataStore of the report.
Parameters
- datas (StiDataCollection) — DataCollection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns StiReport
RegDataAsync
RegDataAsync(name: string, data: object, synchronize: bool): Task<StiReport>
Asynchronously registers an object in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- data (object) — The object for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, dataTable: DataTable, synchronize: bool): Task<StiReport>
Asynchronously registers an object in the Data Store.
Parameters
- name (string) — DataTable name in the Data Store.
- dataTable (DataTable) — DataTable for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(dataTable: DataTable, synchronize: bool): Task<StiReport>
Asynchronously registers the DataTable in the Data Store.
Parameters
- dataTable (DataTable) — The DataTable for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, dataSet: DataSet, synchronize: bool): Task<StiReport>
Asynchronously registers all Data-Tables and Data-Relations which are in the specified DataSet in the report.
Parameters
- name (string) — A name for the DataSet registration.
- dataSet (DataSet) — The DataSet for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(dataSet: DataSet, synchronize: bool): Task<StiReport>
Asynchronously registers all DataTable and DataRelation which are in the specified DataSet in the Data Store.
Parameters
- dataSet (DataSet) — DataSet for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, dataView: DataView, synchronize: bool): Task<StiReport>
Asynchronously registers DataView in the Data Store.
Parameters
- name (string) — DataView name in the Data Store.
- dataView (DataView) — DataView for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(dataView: DataView, synchronize: bool): Task<StiReport>
Asynchronously registers DataView in the Data Store.
Parameters
- dataView (DataView) — DataView for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, connection: SqlConnection, synchronize: bool): Task<StiReport>
Asynchronously registers SqlConnection in the Data Store.
Parameters
- name (string) — SqlConnection name in the Data Store.
- connection (SqlConnection) — SqlConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, connection: OleDbConnection, synchronize: bool): Task<StiReport>
Asynchronously registers OleDbConnection in the Data Store.
Parameters
- name (string) — OleDbConnection name in the Data Store.
- connection (OleDbConnection) — OleDbConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, connection: OdbcConnection, synchronize: bool): Task<StiReport>
Asynchronously registers OdbcConnection in the Data Store.
Parameters
- name (string) — OdbcConnection name in the Data Store.
- connection (OdbcConnection) — OdbcConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, alias: string, data: object, synchronize: bool): Task<StiReport>
Asynchronously registers an object in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- data (object) — The object for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, alias: string, dataTable: DataTable, synchronize: bool): Task<StiReport>
Asynchronously registers an object in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- dataTable (DataTable) — DataTable for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, alias: string, dataSet: DataSet, synchronize: bool): Task<StiReport>
Asynchronously registers all DataTables and DataRelations which are in the specified DataSet in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- dataSet (DataSet) — DataSet for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, alias: string, dataView: DataView, synchronize: bool): Task<StiReport>
Asynchronously registers DataView in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- dataView (DataView) — DataView for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, alias: string, connection: SqlConnection, synchronize: bool): Task<StiReport>
Asynchronously registers SqlConnection in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- connection (SqlConnection) — SqlConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, alias: string, connection: OleDbConnection, synchronize: bool): Task<StiReport>
Asynchronously registers OleDbConnection in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- connection (OleDbConnection) — OleDbConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(name: string, alias: string, connection: OdbcConnection, synchronize: bool): Task<StiReport>
Asynchronously registers OdbcConnection in the Data Store.
Parameters
- name (string) — A data name in the Data Store.
- alias (string) — A data alias in the Data Store.
- connection (OdbcConnection) — OdbcConnection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDataAsync(datas: StiDataCollection, synchronize: bool): Task<StiReport>
Asynchronously registers the DataCollection in the DataStore of the report.
Parameters
- datas (StiDataCollection) — DataCollection for registration.
- synchronize (bool) — Synchronizes, if true, the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
Returns Task<StiReport>
RegDbfData
RegDbfData(name: string, **: bytedata, **synchronize: bool): StiDatabase
Registers a new connection to the DBF data file.
Parameters
- name (string) — A name of the DBF connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the DBF data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegDbfDataAsync
RegDbfDataAsync(name: string, **: bytedata, **synchronize: bool): Task
Asynchronously registers a new connection to the DBF data file.
Parameters
- name (string) — A name of the DBF connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the DBF data file will be created or updated in the Dictionary.
Returns Task
RegDbfFile
RegDbfFile(name: string, fileName: string, synchronize: bool): StiDatabase
Registers a new connection to the DBF data file.
Parameters
- name (string) — A name of the DBF connection in the dictionary.
- fileName (string) — A file path to the DBF data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the DBF data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegDbfFileAsync
RegDbfFileAsync(name: string, fileName: string, synchronize: bool): Task
Registers a new connection to the DBF data file.
Parameters
- name (string) — A name of the DBF connection in the dictionary.
- fileName (string) — A file path to the DBF data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the DBF data file will be created or updated in the Dictionary.
Returns Task
RegExcelData
RegExcelData(name: string, **: bytedata, **synchronize: bool): StiDatabase
Registers a new connection to the EXCEL data file.
Parameters
- name (string) — A name of the EXCEL connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the EXCEL data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegExcelDataAsync
RegExcelDataAsync(name: string, **: bytedata, **synchronize: bool): Task
Asynchronously registers a new connection to the EXCEL data file.
Parameters
- name (string) — A name of the EXCEL connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the EXCEL data file will be created or updated in the Dictionary.
Returns Task
RegExcelFile
RegExcelFile(name: string, fileName: string, synchronize: bool): StiDatabase
Registers a new connection to the EXCEL data file.
Parameters
- name (string) — A name of the EXCEL connection in the dictionary.
- fileName (string) — A file path to the EXCEL data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the EXCEL data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegExcelFileAsync
RegExcelFileAsync(name: string, fileName: string, synchronize: bool): Task
Registers a new connection to the EXCEL data file.
Parameters
- name (string) — A name of the EXCEL connection in the dictionary.
- fileName (string) — A file path to the EXCEL data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the EXCEL data file will be created or updated in the Dictionary.
Returns Task
RegFirebirdConnection
RegFirebirdConnection(name: string, connectionString: string, synchronize: bool): StiDatabase
Registers a Firebird connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns StiDatabase — The registered database.
RegFirebirdConnectionAsync
RegFirebirdConnectionAsync(name: string, connectionString: string, synchronize: bool): Task
Asynchronously registers a Firebird connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns Task
RegJsonData
RegJsonData(name: string, **: bytedata, **synchronize: bool): StiDatabase
Registers a new connection to the JSON data file.
Parameters
- name (string) — A name of the JSON connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the JSON data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegJsonDataAsync
RegJsonDataAsync(name: string, **: bytedata, **synchronize: bool): Task
Asynchronously registers a new connection to the JSON data file.
Parameters
- name (string) — A name of the JSON connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the JSON data file will be created or updated in the Dictionary.
Returns Task
RegJsonFile
RegJsonFile(name: string, fileName: string, synchronize: bool): StiDatabase
Registers a new connection to the JSON data file.
Parameters
- name (string) — A name of the JSON connection in the dictionary.
- fileName (string) — A file path to the JSON data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the JSON data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegJsonFileAsync
RegJsonFileAsync(name: string, fileName: string, synchronize: bool): Task
Registers a new connection to the JSON data file.
Parameters
- name (string) — A name of the JSON connection in the dictionary.
- fileName (string) — A file path to the JSON data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the JSON data file will be created or updated in the Dictionary.
Returns Task
RegMySqlConnection
RegMySqlConnection(name: string, connectionString: string, synchronize: bool): StiDatabase
Registers a MySQL connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns StiDatabase — The registered database.
RegMySqlConnectionAsync
RegMySqlConnectionAsync(name: string, connectionString: string, synchronize: bool): Task
Asynchronously registers a MySQL connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns Task
RegOdbcConnection
RegOdbcConnection(name: string, connectionString: string, synchronize: bool): StiDatabase
Registers an ODBC connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns StiDatabase — The registered database.
RegOdbcConnectionAsync
RegOdbcConnectionAsync(name: string, connectionString: string, synchronize: bool): Task
Asynchronously registers an ODBC connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns Task
RegOleDbConnection
RegOleDbConnection(name: string, connectionString: string, synchronize: bool): StiDatabase
Registers an OLEDB connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns StiDatabase — The registered database.
RegOleDbConnectionAsync
RegOleDbConnectionAsync(name: string, connectionString: string, synchronize: bool): Task
Asynchronously registers an OLEDB connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns Task
RegOracleConnection
RegOracleConnection(name: string, connectionString: string, synchronize: bool): StiDatabase
Registers an Oracle connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns StiDatabase — The registered database.
RegOracleConnectionAsync
RegOracleConnectionAsync(name: string, connectionString: string, synchronize: bool): Task
Asynchronously registers an Oracle connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns Task
RegPostgreSqlConnection
RegPostgreSqlConnection(name: string, connectionString: string, synchronize: bool): StiDatabase
Registers a PostgreSQL connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns StiDatabase — The registered database.
RegPostgreSqlConnectionAsync
RegPostgreSqlConnectionAsync(name: string, connectionString: string, synchronize: bool): Task
Asynchronously registers a PostgreSQL connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns Task
RegReportDataSources
RegReportDataSources(): StiReport
Internal use only. Registers datasources from ReportDataSources property in report dictionary.
Returns StiReport
RegSqlServerConnection
RegSqlServerConnection(name: string, connectionString: string, synchronize: bool): StiDatabase
Registers a SQL Server connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns StiDatabase — The registered database.
RegSqlServerConnectionAsync
RegSqlServerConnectionAsync(name: string, connectionString: string, synchronize: bool): Task
Asynchronously registers a SQL Server connection.
Parameters
- name (string) — The name of the connection.
- connectionString (string) — The connection string.
- synchronize (bool) — Indicates whether to synchronize the connection.
Returns Task
RegXmlData
RegXmlData(name: string, **: bytedata, **synchronize: bool): StiDatabase
Registers a new connection to the XML data file.
Parameters
- name (string) — A name of the XML connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegXmlData(name: string, **: byteschema, **: bytedata, synchronize: bool): StiDatabase
Registers a new connection to the XML data file.
Parameters
- name (string) — A name of the XML connection in the dictionary.
- ** (byteschema)
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegXmlDataAsync
RegXmlDataAsync(name: string, **: bytedata, **synchronize: bool): Task
Asynchronously registers a new connection to the XML data file.
Parameters
- name (string) — A name of the XML connection in the dictionary.
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
Returns Task
RegXmlDataAsync(name: string, **: byteschema, **: bytedata, synchronize: bool): Task
Asynchronously registers a new connection to the XML data file.
Parameters
- name (string) — A name of the XML connection in the dictionary.
- ** (byteschema)
- ** (bytedata)
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
Returns Task
RegXmlFile
RegXmlFile(name: string, fileName: string, synchronize: bool): StiDatabase
Registers a new connection to the XML data file.
Parameters
- name (string) — A name of the XML connection in the dictionary.
- fileName (string) — A file path to the XML data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
Returns StiDatabase — The created connection in the dictionary.
RegXmlFileAsync
RegXmlFileAsync(name: string, fileName: string, synchronize: bool): Task
Registers a new connection to the XML data file.
Parameters
- name (string) — A name of the XML connection in the dictionary.
- fileName (string) — A file path to the XML data file.
- synchronize (bool) — If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
Returns Task
Render
Render(): StiReport
Renders a report.
Returns StiReport
Render(showProgress: bool): StiReport
Renders a report.
Parameters
- showProgress (bool) — Whether it is necessary to show the progress of report rendering or not.
Returns StiReport
Render(showProgress: bool, fromPage: int, toPage: int): StiReport
Renders a report.
Parameters
- showProgress (bool) — Whether it is necessary to show the progress of report rendering or not.
- fromPage (int) — Specifies from which page the result of the report rendering should be presented into the rendered report.
- toPage (int) — Specifies to which page the result of the report rendering should be presented into the rendered report.
Returns StiReport
Render(renderState: StiRenderState): StiReport
Renders report.
Parameters
- renderState (StiRenderState) — Specifies a parameters for the report rendering.
Returns StiReport
RenderAsync
RenderAsync(): Task<StiReport>
Renders a report.
Returns Task<StiReport>
RenderAsync(fromPage: int, toPage: int): Task<StiReport>
Renders a report.
Parameters
- fromPage (int) — Specifies from which page the result of the report rendering should be presented into the rendered report.
- toPage (int) — Specifies to which page the result of the report rendering should be presented into the rendered report.
Returns Task<StiReport>
RenderAsync(renderState: StiRenderState): Task<StiReport>
Renders report.
Parameters
- renderState (StiRenderState) — Specifies a parameters for the report rendering.
Returns Task<StiReport>
RenderWithWpf
RenderWithWpf(): StiReport
Renders a report with using WPF technology.
Returns StiReport
RenderWithWpf(showProgress: bool): StiReport
Renders a report with using WPF technology.
Parameters
- showProgress (bool) — Whether it is necessary to show the progress of report rendering or not.
Returns StiReport
RenderWithWpf(showProgress: bool, fromPage: int, toPage: int): StiReport
Renders a report with using WPF technology.
Parameters
- showProgress (bool) — Whether it is necessary to show the progress of report rendering or not.
- fromPage (int)
- toPage (int)
Returns StiReport
RenderWithWpf(renderState: StiRenderState): StiReport
Renders a report with using WPF technology.
Parameters
- renderState (StiRenderState)
Returns StiReport
ResetAggregateFunctions
ResetAggregateFunctions(): StiReport
Resets states of aggregate functions in compiled report.
Returns StiReport
ResetRenderedState
ResetRenderedState(): StiReport
Resets a rendered states.
Returns StiReport
Save
Save(stream: Stream): StiReport
Saves a report template in the stream.
Parameters
- stream (Stream) — A stream for saving a report template.
Returns StiReport
Save(service: StiReportSLService, stream: Stream): StiReport
Saves a report template in the file using the provider.
Parameters
- service (StiReportSLService) — A provider which saves the report template.
- stream (Stream) — A stream for saving a report template.
Returns StiReport
Save(service: StiReportSLService, path: string): StiReport
Saves a report template in the file using the provider.
Parameters
- service (StiReportSLService) — A provider for saving a rendered report.
- path (string) — A file for saving the report template.
Returns StiReport
Save(path: string): StiReport
Saves a report template in the file.
Parameters
- path (string) — A file to save a report template.
Returns StiReport
SaveAsync
SaveAsync(stream: Stream): Task<StiReport>
Saves asynchronously a report template in the stream.
Parameters
- stream (Stream) — A stream for saving a report template.
Returns Task<StiReport>
SaveAsync(service: StiReportSLService, stream: Stream): Task<StiReport>
Saves asynchronously a report template in the file using the provider.
Parameters
- service (StiReportSLService) — A provider which saves the report template.
- stream (Stream) — A stream for saving a report template.
Returns Task<StiReport>
SaveAsync(service: StiReportSLService, path: string): Task<StiReport>
Saves asynchronously a report template in the file using the provider.
Parameters
- service (StiReportSLService) — A provider for saving a rendered report.
- path (string) — A file for saving the report template.
Returns Task<StiReport>
SaveAsync(path: string): Task<StiReport>
Saves asynchronously a report template in the file.
Parameters
- path (string) — A file to save a report template.
Returns Task<StiReport>
SaveDocument
SaveDocument(stream: Stream): StiReport
Saves a rendered report in the stream.
Parameters
- stream (Stream) — A stream to save a rendered report.
Returns StiReport
SaveDocument(service: StiDocumentSLService, stream: Stream): StiReport
Saves a rendered report to the stream.
Parameters
- service (StiDocumentSLService) — A provider which saves a rendered report.
- stream (Stream) — A stream to save a rendered report.
Returns StiReport
SaveDocument(service: StiDocumentSLService, path: string): StiReport
Saves a rendered report using the provider in the file.
Parameters
- service (StiDocumentSLService) — A provider that saves a rendered report.
- path (string) — A file to save a rendered report.
Returns StiReport
SaveDocument(path: string): StiReport
Saves a rendered report in the file.
Parameters
- path (string) — A file to save a rendered report.
Returns StiReport
SaveDocumentAsync
SaveDocumentAsync(stream: Stream): Task<StiReport>
Saves asynchronously a rendered report in the stream.
Parameters
- stream (Stream) — A stream to save a rendered report.
Returns Task<StiReport>
SaveDocumentAsync(service: StiDocumentSLService, stream: Stream): Task<StiReport>
Saves asynchronously a rendered report to the stream.
Parameters
- service (StiDocumentSLService) — A provider which saves a rendered report.
- stream (Stream) — A stream to save a rendered report.
Returns Task<StiReport>
SaveDocumentAsync(service: StiDocumentSLService, path: string): Task<StiReport>
Saves asynchronously a rendered report using the provider in the file.
Parameters
- service (StiDocumentSLService) — A provider that saves a rendered report.
- path (string) — A file to save a rendered report.
Returns Task<StiReport>
SaveDocumentAsync(path: string): Task<StiReport>
Saves asynchronously a rendered report in the file.
Parameters
- path (string) — A file to save a rendered report.
Returns Task<StiReport>
SaveDocumentJsonToString
SaveDocumentJsonToString(): string
Saves a rendered report to the string.
Returns string — A string which contains the report template.
SaveDocumentJsonToStringAsync
SaveDocumentJsonToStringAsync(): Task
Saves asynchronously a rendered report to the string.
Returns Task
SaveDocumentToByteArray
SaveDocumentToByteArray(): byte[]
Saves a rendered report to the byte array.
Returns byte[] — Returns a byte array which contains a rendered report.
SaveDocumentToByteArrayAsync
SaveDocumentToByteArrayAsync(): Task<byte[]>
Saves asynchronously a rendered report to the byte array.
Returns Task<byte[]> — Returns a byte array which contains a rendered report.
SaveDocumentToString
SaveDocumentToString(): string
Saves a rendered report to the string.
Returns string — A string which contains the report template.
SaveDocumentToStringAsync
SaveDocumentToStringAsync(): Task
Saves asynchronously a rendered report to the string.
Returns Task
SaveEditableFields
SaveEditableFields(path: string): StiReport
Saves the editable fields of rendered report to the stream.
Parameters
- path (string)
Returns StiReport
SaveEditableFields(stream: Stream): StiReport
Saves the editable fields of rendered report to the stream.
Parameters
- stream (Stream) — Stream for saving the editable fields.
Returns StiReport
SaveEncryptedDocument
SaveEncryptedDocument(stream: Stream, key: string): StiReport
Saves an encrypted rendered report to the stream.
Parameters
- stream (Stream) — A stream to save an encrypted rendered report.
- key (string) — The key for encryption.
Returns StiReport
SaveEncryptedDocument(path: string, key: string): StiReport
Saves a packed rendered report in the file.
Parameters
- path (string) — A file for saving a packed rendered report.
- key (string)
Returns StiReport
SaveEncryptedDocumentAsync
SaveEncryptedDocumentAsync(stream: Stream, key: string): Task<StiReport>
Saves asynchronously an encrypted rendered report to the stream.
Parameters
- stream (Stream) — A stream to save an encrypted rendered report.
- key (string) — The key for encryption.
Returns Task<StiReport>
SaveEncryptedDocumentAsync(path: string, key: string): Task<StiReport>
Saves asynchronously a packed rendered report in the file.
Parameters
- path (string) — A file for saving a packed rendered report.
- key (string)
Returns Task<StiReport>
SaveEncryptedDocumentToByteArray
SaveEncryptedDocumentToByteArray(key: string): byte[]
Saves an encrypted rendered report to the byte array.
Parameters
- key (string)
Returns byte[] — A byte array which contains an encrypted rendered report.
SaveEncryptedDocumentToByteArrayAsync
SaveEncryptedDocumentToByteArrayAsync(key: string): Task<byte[]>
Saves asynchronously an encrypted rendered report to the byte array.
Parameters
- key (string)
Returns Task<byte[]> — A byte array which contains an encrypted rendered report.
SaveEncryptedDocumentToString
SaveEncryptedDocumentToString(key: string): string
Saves an encrypted rendered report to the string.
Parameters
- key (string)
Returns string — A string which contains an encrypted rendered report.
SaveEncryptedDocumentToStringAsync
SaveEncryptedDocumentToStringAsync(key: string): Task
Saves an encrypted rendered report to the string.
Parameters
- key (string)
Returns Task
SaveEncryptedReport
SaveEncryptedReport(stream: Stream, key: string): StiReport
Saves an encrypted report template in the stream.
Parameters
- stream (Stream) — A stream to save an encrypted report template.
- key (string)
Returns StiReport
SaveEncryptedReport(path: string, key: string): StiReport
Saves an encrypted report template in the file.
Parameters
- path (string) — A file to save an encrypted report template.
- key (string)
Returns StiReport
SaveEncryptedReportAsync
SaveEncryptedReportAsync(stream: Stream, key: string): Task<StiReport>
Saves asynchronously an encrypted report template in the stream.
Parameters
- stream (Stream) — A stream to save an encrypted report template.
- key (string)
Returns Task<StiReport>
SaveEncryptedReportAsync(path: string, key: string): Task<StiReport>
Saves asynchronously an encrypted report template in the file.
Parameters
- path (string) — A file to save an encrypted report template.
- key (string)
Returns Task<StiReport>
SaveEncryptedReportToByteArray
SaveEncryptedReportToByteArray(key: string): byte[]
Saves an encrypted report template in the byte array.
Parameters
- key (string)
Returns byte[] — A new byte array containing the encrypted report template.
SaveEncryptedReportToByteArrayAsync
SaveEncryptedReportToByteArrayAsync(key: string): Task<byte[]>
Saves asynchronously an encrypted report template in the byte array.
Parameters
- key (string)
Returns Task<byte[]> — A new byte array containing the encrypted report template.
SaveEncryptedReportToString
SaveEncryptedReportToString(key: string): string
Saves an encrypted report template to the string.
Parameters
- key (string)
Returns string — A string which contains an encrypted report template.
SaveEncryptedReportToStringAsync
SaveEncryptedReportToStringAsync(key: string): Task
Saves asynchronously an encrypted report template to the string.
Parameters
- key (string)
Returns Task
SavePackedDocument
SavePackedDocument(stream: Stream): StiReport
Saves a packed rendered report to the stream.
Parameters
- stream (Stream) — A stream to save a packed rendered report.
Returns StiReport
SavePackedDocument(path: string): StiReport
Saves a packed rendered report in the file.
Parameters
- path (string) — A file for saving a packed rendered report.
Returns StiReport
SavePackedDocumentAsync
SavePackedDocumentAsync(stream: Stream): Task<StiReport>
Saves asynchronously a packed rendered report to the stream.
Parameters
- stream (Stream) — A stream to save a packed rendered report.
Returns Task<StiReport>
SavePackedDocumentAsync(path: string): Task<StiReport>
Saves asynchronously a packed rendered report in the file.
Parameters
- path (string) — A file for saving a packed rendered report.
Returns Task<StiReport>
SavePackedDocumentToByteArray
SavePackedDocumentToByteArray(): byte[]
Saves a packed rendered report to the byte array.
Returns byte[] — A byte array which contains a packed rendered report.
SavePackedDocumentToByteArrayAsync
SavePackedDocumentToByteArrayAsync(): Task<byte[]>
Saves asynchronously a packed rendered report to the byte array.
Returns Task<byte[]> — A byte array which contains a packed rendered report.
SavePackedDocumentToString
SavePackedDocumentToString(): string
Saves a packed rendered report to the string.
Returns string — A string which contains a packed rendered report.
SavePackedDocumentToStringAsync
SavePackedDocumentToStringAsync(): Task
Saves asynchronously a packed rendered report to the string.
Returns Task
SavePackedReport
SavePackedReport(stream: Stream): StiReport
Saves a packed report template in the stream.
Parameters
- stream (Stream) — A stream to save a packed report template.
Returns StiReport
SavePackedReport(path: string): StiReport
Saves a packed report template in the file.
Parameters
- path (string) — A file to save a packed report template.
Returns StiReport
SavePackedReportAsync
SavePackedReportAsync(stream: Stream): Task<StiReport>
Saves asynchronously a packed report template in the stream.
Parameters
- stream (Stream) — A stream to save a packed report template.
Returns Task<StiReport>
SavePackedReportAsync(path: string): Task<StiReport>
Saves asynchronously a packed report template in the file.
Parameters
- path (string) — A file to save a packed report template.
Returns Task<StiReport>
SavePackedReportToByteArray
SavePackedReportToByteArray(): byte[]
Saves a packed report template in the byte array.
Returns byte[] — A new byte array containing the packed report template.
SavePackedReportToByteArrayAsync
SavePackedReportToByteArrayAsync(): Task<byte[]>
Saves asynchronously a packed report template in the byte array.
Returns Task<byte[]> — A new byte array containing the packed report template.
SavePackedReportToString
SavePackedReportToString(): string
Saves a packed report template to the string.
Returns string — A string which contains a packed report template.
SavePackedReportToStringAsync
SavePackedReportToStringAsync(): Task
Saves a packed report template to the string.
Returns Task
SaveReportSourceCode
SaveReportSourceCode(): string
Saves the report source code to the string.
Returns string
SaveReportSourceCode(saveForInheritedReports: bool): string
Saves the report source code to the string.
Parameters
- saveForInheritedReports (bool)
Returns string
SaveReportSourceCode(stream: Stream): StiReport
Saves the report source code to the stream.
Parameters
- stream (Stream) — Stream for saving the source code.
Returns StiReport
SaveReportSourceCode(stream: Stream, saveForInheritedReports: bool): StiReport
Saves the report source code to the stream.
Parameters
- stream (Stream) — Stream for saving the source code.
- saveForInheritedReports (bool)
Returns StiReport
SaveReportSourceCode(path: string): StiReport
Saves the report source code to the file.
Parameters
- path (string) — Parameter specifies a path to the file the report is exported to.
Returns StiReport
SaveReportSourceCode(path: string, saveForInheritedReports: bool): StiReport
Saves the report source code to the file.
Parameters
- path (string) — Parameter specifies a path to the file the report is exported to.
- saveForInheritedReports (bool)
Returns StiReport
SaveSnapshot
SaveSnapshot(path: string): StiReport
Saves a report template with embedded data
Parameters
- path (string) — A file to save a report template with embedded data.
Returns StiReport
SaveSnapshot(stream: Stream): StiReport
Saves a report template with embedded data to the stream.
Parameters
- stream (Stream) — A stream to save a report template with embedded data.
Returns StiReport
SaveSnapshotAsync
SaveSnapshotAsync(path: string): Task<StiReport>
Saves asynchronously a report template with embedded data.
Parameters
- path (string) — A file to save a report template with embedded data.
Returns Task<StiReport>
SaveSnapshotAsync(stream: Stream): Task<StiReport>
Saves asynchronously a report template with embedded data to the stream.
Parameters
- stream (Stream) — A stream to save a report template with embedded data.
Returns Task<StiReport>
SaveSnapshotToByteArray
SaveSnapshotToByteArray(): byte[]
Saves a report template with embedded data to a byte array.
Returns byte[] — The new byte array containing a report snapshot.
SaveSnapshotToByteArrayAsync
SaveSnapshotToByteArrayAsync(): Task<byte[]>
Saves asynchronously a report template with embedded data to a byte array.
Returns Task<byte[]> — The new byte array containing a report snapshot.
SaveToByteArray
SaveToByteArray(): byte[]
Saves a report template in the byte array.
Returns byte[] — A byte array which contains the report template.
SaveToByteArrayAsync
SaveToByteArrayAsync(): Task<byte[]>
Saves asynchronously a report template in the byte array.
Returns Task<byte[]> — A byte array which contains the report template.
SaveToJson
SaveToJson(path: string): StiReport
Saves a report template in the file.
Parameters
- path (string) — A file to save a report template.
Returns StiReport
SaveToJsonAsync
SaveToJsonAsync(path: string): Task<StiReport>
Saves asynchronously a report template in the file.
Parameters
- path (string) — A file to save a report template.
Returns Task<StiReport>
SaveToJsonString
SaveToJsonString(): string
Saves a report template to the string.
Returns string — A string which contains the report template.
SaveToJsonStringAsync
SaveToJsonStringAsync(): Task
Saves asynchronously a report template to the string.
Returns Task
SaveToString
SaveToString(): string
Saves a report template to the string.
Returns string — A string which contains the report template.
SaveToStringAsync
SaveToStringAsync(): Task
Saves asynchronously a report template to the string.
Returns Task
Show
Show(): StiReport
Shows a rendered report. If the report is not rendered then its rendering starts.
Returns StiReport
Show(dialogForm: bool): StiReport
Shows the rendered report as a dialog form or not. If the report is not rendered then its rendering starts.
Parameters
- dialogForm (bool) — If this parameter is true then the report will be rendered as a dialog form.
Returns StiReport
Show(parentForm: Form): StiReport
Shows the rendered report as MDI child window. If the report is not rendered then its rendering starts.
Parameters
- parentForm (Form) — A parent form in the MDI application.
Returns StiReport
Show(owner: IWin32Window): StiReport
Shows the rendered report as MDI child window. If the report is not rendered then its rendering starts.
Parameters
- owner (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
Returns StiReport
Show(owner: IWin32Window, dialogForm: bool): StiReport
Shows the rendered report as MDI child window. If the report is not rendered then its rendering starts.
Parameters
- owner (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
- dialogForm (bool) — If this parameter is true then the report will be shown as a dialog form.
Returns StiReport
ShowDotMatrix
ShowDotMatrix(): StiReport
Shows a rendered report in DotMatrix mode. If the report is not rendered then its rendering starts.
Returns StiReport
ShowDotMatrix(dialogForm: bool): StiReport
Shows the rendered report in DotMatrix mode as a dialog form or not. If the report is not rendered then its rendering starts.
Parameters
- dialogForm (bool) — If this parameter is true then the report will be rendered as a dialog form.
Returns StiReport
ShowDotMatrix(parentForm: Form): StiReport
Shows the rendered report in DotMatrix mode as MDI child window. If the report is not rendered then its rendering starts.
Parameters
- parentForm (Form) — A parent form in the MDI application.
Returns StiReport
ShowDotMatrix(owner: IWin32Window): StiReport
Shows the rendered report in DotMatrix mode as MDI child window. If the report is not rendered then its rendering starts.
Parameters
- owner (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
Returns StiReport
ShowDotMatrix(owner: IWin32Window, dialogForm: bool): StiReport
Shows the rendered report in DotMatrix mode as MDI child window. If the report is not rendered then its rendering starts.
Parameters
- owner (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
- dialogForm (bool) — If this parameter is true then the report will be shown as a dialog form.
Returns StiReport
ShowDotMatrixWithRibbonGUI
ShowDotMatrixWithRibbonGUI(): StiReport
Returns StiReport
ShowDotMatrixWithRibbonGUI(dialogForm: bool): StiReport
Parameters
- dialogForm (bool)
Returns StiReport
ShowDotMatrixWithRibbonGUI(parentForm: Form): StiReport
Parameters
- parentForm (Form)
Returns StiReport
ShowDotMatrixWithRibbonGUI(owner: IWin32Window): StiReport
Parameters
- owner (IWin32Window)
Returns StiReport
ShowDotMatrixWithRibbonGUI(owner: IWin32Window, dialogForm: bool): StiReport
Parameters
- owner (IWin32Window)
- dialogForm (bool)
Returns StiReport
ShowDotMatrixWithWpf
ShowDotMatrixWithWpf(): StiReport
Shows a rendered report in DotMatrix mode with using WPF technology. If the report is not rendered then its rendering starts.
Returns StiReport
ShowDotMatrixWithWpf(dialogWindow: bool): StiReport
Shows the rendered report in DotMatrix mode as a dialog form or not with using WPF technology. If the report is not rendered then its rendering starts.
Parameters
- dialogWindow (bool) — If this parameter is true then the report will be rendered as a dialog window.
Returns StiReport
ShowWithRibbonGUI
ShowWithRibbonGUI(): StiReport
Shows a rendered report in viewer with Ribbon GUI. If the report is not rendered then its rendering starts.
Returns StiReport
ShowWithRibbonGUI(dialogForm: bool): StiReport
Shows the rendered report as a dialog form or not with Ribbon GUI. If the report is not rendered then its rendering starts.
Parameters
- dialogForm (bool) — If this parameter is true then the report will be rendered as a dialog form.
Returns StiReport
ShowWithRibbonGUI(parentForm: Form): StiReport
Shows the rendered report as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Parameters
- parentForm (Form) — A parent form in the MDI application.
Returns StiReport
ShowWithRibbonGUI(owner: IWin32Window): StiReport
Shows the rendered report as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Parameters
- owner (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
Returns StiReport
ShowWithRibbonGUI(owner: IWin32Window, dialogForm: bool): StiReport
Shows the rendered report as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Parameters
- owner (IWin32Window) — Provides an interface to expose parent Win32 HWND handle.
- dialogForm (bool) — If this parameter is true then the report will be shown as a dialog form.
Returns StiReport
ShowWithWpf
ShowWithWpf(): StiReport
Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts.
Returns StiReport
ShowWithWpf(dialogWindow: bool): StiReport
Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts.
Parameters
- dialogWindow (bool) — If this parameter is true then the report will be shown as a dialog window.
Returns StiReport
ShowWithWpf(ownerWindow: object): StiReport
Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts.
Parameters
- ownerWindow (object) — A parent form.
Returns StiReport
ShowWithWpf(ownerWindow: object, dialogWindow: bool): StiReport
Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts.
Parameters
- ownerWindow (object) — A parent form.
- dialogWindow (bool) — If this parameter is true then the report will be shown as a dialog window.
Returns StiReport
ShowWithWpfRibbonGUI
ShowWithWpfRibbonGUI(): StiReport
Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts.
Returns StiReport
ShowWithWpfRibbonGUI(dialogWindow: bool): StiReport
Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts.
Parameters
- dialogWindow (bool) — If this parameter is true then the report will be shown as a dialog window.
Returns StiReport
ShowWithWpfRibbonGUI(ownerWindow: object): StiReport
Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts.
Parameters
- ownerWindow (object) — A parent form.
Returns StiReport
ShowWithWpfRibbonGUI(ownerWindow: object, dialogWindow: bool): StiReport
Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts.
Parameters
- ownerWindow (object) — A parent form.
- dialogWindow (bool) — If this parameter is true then the report will be shown as a dialog window.
Returns StiReport
Fields
| Field | Type | Description |
|---|---|---|
| Date | DateTime | |
| Date | DateTime | |
| GlobalizationStrings | StiGlobalizationContainerCollection | |
| IsFirstPage | bool | |
| IsFirstPageThrough | bool | |
| IsFirstPass | bool | |
| IsLastPage | bool | |
| IsLastPageThrough | bool | |
| IsSecondPass | bool | |
| LineABC | string | |
| LineRoman | string | |
| PageNofM | string | |
| Time | DateTime | |
| Time | DateTime | |
| Today | DateTime | |
| Today | DateTime |