# ISalReport

Namespace: **PPJ.Runtime**

Assembly: **PPJ.Runtime.49** (4.9.0.0)

Interface to the report provider object.

{% tabs %}
{% tab title="C#" %}

```csharp
public interface ISalReport
```

{% endtab %}

{% tab title="VB.NET" %}

```visual-basic
Public Interface ISalReport
```

{% endtab %}
{% endtabs %}

## Properties

### ![](/files/dBIrS7XBDGmrzmTRbSI6)DocumentName

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string): Name of the printing document.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)FileName

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string): The report file name.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)InputItems

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string): List of bind input variables, separated by a comma.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)LastPageNumber

[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32): Returns the last page number.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)Owner

[Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control): The owner control for the report. This is the control that receives the report's notifications.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)PrinterSettings

[PrinterSettings](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.printing.printersettings): Returns the printer settings to use when printing the report.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)ProgressCaption

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string): Title of the progress dialog.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)ProgressText

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string): Text to show in the progress dialog. It can be up to two lines separated by a CRLF.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)ReportDocument

[Object](https://docs.microsoft.com/en-us/dotnet/api/system.object): Returns the underlying report object.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)TableWindowSource

[SalTableWindow](/ppj.runtime.49/interfaces/ppj.runtime.isalreport.md): TableWindow control to be used as the data source for the report.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)Variables

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string): List of report variables, separated by a comma.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)Viewer

[Control](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control): Returns the current instance of the report viewer.

## Methods

### ![](/files/dBIrS7XBDGmrzmTRbSI6)ClosePreview()

Closes the preview window.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](https://docs.microsoft.com/en-us/dotnet/api/system.string) |             |

**Returns:** [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](https://docs.microsoft.com/en-us/dotnet/api/system.int32) |             |

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](https://docs.microsoft.com/en-us/dotnet/api/system.string) |             |
| **firstPage** | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)   |             |
| **lastPage**  | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)   |             |
| **options**   | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)   |             |

**Returns:** [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)GetReportVariable(name)

Returns the value of the specified report variable.

| Parameter | Type                                                                | Description |
| --------- | ------------------------------------------------------------------- | ----------- |
| **name**  | [String](https://docs.microsoft.com/en-us/dotnet/api/system.string) |             |

**Returns:** [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)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](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control) |             |
| **options** | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)                   |             |

**Returns:** [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)Print(copies, firstPage, lastPage, options)

Prints the report.

| Parameter     | Type                                                              | Description |
| ------------- | ----------------------------------------------------------------- | ----------- |
| **copies**    | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32) |             |
| **firstPage** | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32) |             |
| **lastPage**  | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32) |             |
| **options**   | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32) |             |

**Returns:** [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32).

### ![](/files/dBIrS7XBDGmrzmTRbSI6)Reset()

Regenerates the data set and refreshes the report.

### ![](/files/dBIrS7XBDGmrzmTRbSI6)SetReportVariable(name, value)

Sets the value of the specified report variable.

| Parameter | Type                                                                | Description |
| --------- | ------------------------------------------------------------------- | ----------- |
| **name**  | [String](https://docs.microsoft.com/en-us/dotnet/api/system.string) |             |
| **value** | [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) |             |

**Returns:** [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://desktop-api.iceteagroup.com/ppj.runtime.49/interfaces/ppj.runtime.isalreport.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.