# ISalReport

Namespace: **PPJ.Runtime.Windows**

Assembly: **PPJ.Web.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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)DocumentName

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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)FileName

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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)Handle

[IntPtr](https://docs.microsoft.com/en-us/dotnet/api/system.intptr): Return the handle of the ISalReport instance.

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)InputItems

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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)LastPageNumber

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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)Owner

[Control](https://docs.wisej.com/api?q=wisej.web.control): The owner control for the report. This is the control that receives the report's notifications.

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)PrinterSettings

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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)ProgressCaption

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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)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.

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)ReportDocument

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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)TableWindowSource

[SalTableWindow](https://docs.wisej.com/extensions/ppj.web.49/controls/saltablewindow/saltablewindow/README.md): TableWindow control to be used as the data source for the report.

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)Variables

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

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)Viewer

[Control](https://docs.wisej.com/api?q=wisej.web.control): Returns the current instance of the report viewer.

## Methods

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)ClosePreview()

Closes the preview window.

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)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).

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)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) |             |

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)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).

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)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).

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)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.wisej.com/api?q=wisej.web.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).

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)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).

### ![](https://620403885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FrwxBtXkZ9hhQWYdbGhAV%2Fuploads%2FCKg4odMPj9bBKavXG5j4%2Finstance.png?alt=media\&token=2ac4a01b-785e-4197-b802-d5aae2250f90)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).