ISalReport

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Web.50 (5.0.0.0)

Defines the provider contract for creating, previewing, exporting, and printing SAL reports.

C#

public interface ISalReport

VB.NET

Public Interface ISalReport

Operation status codes and supported options are determined by the report provider.

Example:

void SetTitle(PPJ.Runtime.Windows.ISalReport report)
{
    report.DocumentName = "Monthly report";
    report.ProgressCaption = "Preparing report";
    report.SetReportVariable("Title", "Monthly report");
}

Properties

DocumentName

String: Gets or sets the document name used for printing.

FileName

String: Gets or sets the report file name.

Handle

IntPtr: Gets the runtime handle associated with this report instance.

InputItems

String: Gets or sets the comma-separated list of input bind variables.

LastPageNumber

Int32: Gets the last page number reported by the provider.

Owner

Control: Gets or sets the control that receives report notifications.

PrinterSettings

PrinterSettings: Gets or sets the printer configuration used when printing the report.

ProgressCaption

String: Gets or sets the progress-dialog title.

ProgressText

String: Gets or sets the progress-dialog message, which can contain two lines separated by a carriage return and line feed.

ReportDocument

Object: Gets the underlying provider-specific report document.

TableWindowSource

SalTableWindow: Gets or sets the table window that supplies the report data.

Variables

String: Gets or sets the comma-separated list of report variables.

Viewer

Control: Gets the current report viewer control.

Methods

ClosePreview()

Closes the report's preview window.

Create(file)

Creates a dynamic report from a template.

Parameter	Type	Description
file	String	The template file, or to use the provider's built-in template.

Returns: Int32. The provider's creation status code.

DoPreviewCommand(command)

Sends a report command to the preview window.

Parameter	Type	Description
command	Int32	A Sys.RPT_Cmd* command supported by the provider.

Export(file, firstPage, lastPage, options)

Exports a page range using the format identified by the destination file extension.

Parameter	Type	Description
file	String	The destination file path, including an extension supported by the provider.
firstPage	Int32	The first page to export, interpreted by the provider.
lastPage	Int32	The last page to export, interpreted by the provider.
options	Int32	The provider-supported export option flags.

Returns: Int32. The provider's export status code.

GetReportVariable(name)

Reads a named variable from the report.

Parameter	Type	Description
name	String	The report variable name.

Returns: Object. The variable value returned by the provider.

Preview(parent, options)

Displays the report in a viewer hosted by a control or a new top-level form.

Parameter	Type	Description
parent	Control	The viewer's parent, or to create a top-level preview form.
options	Int32	The provider-supported preview option flags.

Returns: Int32. The provider's preview status code.

Print(copies, firstPage, lastPage, options)

Prints a page range using the configured printer settings.

Parameter	Type	Description
copies	Int32	The requested number of copies.
firstPage	Int32	The first page to print, interpreted by the provider.
lastPage	Int32	The last page to print, interpreted by the provider.
options	Int32	The provider-supported print option flags.

Returns: Int32. The provider's print status code.

SetReportVariable(name, value)

Assigns a value to a named report variable.

Parameter	Type	Description
name	String	The report variable name.
value	Object	The value to assign.

Returns: Boolean. if the provider accepts the assignment; otherwise, .