ISalReport
Namespace: PPJ.Runtime
Assembly: PPJ.Runtime.49 (4.9.0.0)
Interface to the report provider object.
- C#
- VB.NET
public interface ISalReport
Public Interface ISalReport
Properties
DocumentName
String: Name of the printing document.
FileName
String: The report file name.
InputItems
String: List of bind input variables, separated by a comma.
LastPageNumber
Int32: Returns the last page number.
Owner
Control: The owner control for the report. This is the control that receives the report's notifications.
PrinterSettings
PrinterSettings: Returns the printer settings to use when printing the report.
ProgressCaption
String: Title of the progress dialog.
ProgressText
String: Text to show in the progress dialog. It can be up to two lines separated by a CRLF.
ReportDocument
Object: Returns the underlying report object.
TableWindowSource
SalTableWindow: TableWindow control to be used as the data source for the report.
Variables
String: List of report variables, separated by a comma.
Viewer
Control: Returns the current instance of the report viewer.
Methods
ClosePreview()
Closes the preview window.
Create(file)
Creates a new dynamic report using the specified template. If the templates is null (default), the built-in template is used.
| Parameter | Type | Description |
|---|---|---|
| file | String |
Returns: Int32.
DoPreviewCommand(command)
Executes the specified command on the preview window. The command code is one of the Sys.RPT_Cmd* constants.
| Parameter | Type | Description |
|---|---|---|
| command | Int32 |
Export(file, firstPage, lastPage, options)
Exports the report to the specified file. The kind of export is inferred from the extension of the file.
| Parameter | Type | Description |
|---|---|---|
| file | String | |
| firstPage | Int32 | |
| lastPage | Int32 | |
| options | Int32 |
Returns: Int32.
GetReportVariable(name)
Returns the value of the specified report variable.
| Parameter | Type | Description |
|---|---|---|
| name | String |
Returns: Object.
Preview(parent, options)
Preview the report. The report viewer control is hosted in the specified parent. If the parent is null, a new top level form is created.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| options | Int32 |
Returns: Int32.
Print(copies, firstPage, lastPage, options)
Prints the report.
| Parameter | Type | Description |
|---|---|---|
| copies | Int32 | |
| firstPage | Int32 | |
| lastPage | Int32 | |
| options | Int32 |
Returns: Int32.
Reset()
Regenerates the data set and refreshes the report.
SetReportVariable(name, value)
Sets the value of the specified report variable.
| Parameter | Type | Description |
|---|---|---|
| name | String | |
| value | Object |
Returns: Boolean.