Class Engine

This is the i-net Clear Reports report engine. Its purpose is to transform a report template and its associated data.The result can either be binary data to be viewed/printed by the viewer or it can be exported into a lot of export formats, like: HTML, PDF, PS, RTF, XLSX, XML, ....

Inheritance
System.Object
BridgedObject
Engine
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: inetsoftware.Reporting
Assembly: inetsoftware.Reporting.dll
Syntax
public class Engine : BridgedObject

Constructors

Engine(String)

Creates an Engine for specific file output format.

Declaration
public Engine(string format)
Parameters
Type Name Description
System.String format

Fields

EXPORT_BMP

Engine creates BMP output.

Declaration
public const string EXPORT_BMP = "bmp"
Field Value
Type Description
System.String

EXPORT_CSV

Engine creates CSV output.

Declaration
public const string EXPORT_CSV = "csv"
Field Value
Type Description
System.String

EXPORT_DATA

Engine creates data output.

Declaration
public const string EXPORT_DATA = "data"
Field Value
Type Description
System.String

EXPORT_GIF

Engine creates GIF output.

Declaration
public const string EXPORT_GIF = "gif"
Field Value
Type Description
System.String

EXPORT_HTML

Engine creates HTML output.

Declaration
public const string EXPORT_HTML = "htm"
Field Value
Type Description
System.String

EXPORT_JPG

Engine creates JPG output.

Declaration
public const string EXPORT_JPG = "jpg"
Field Value
Type Description
System.String

EXPORT_ODS

Engine creates OpenOffice ODS output.

Declaration
public const string EXPORT_ODS = "ods"
Field Value
Type Description
System.String

EXPORT_PDF

Engine creates PDF output.

Declaration
public const string EXPORT_PDF = "pdf"
Field Value
Type Description
System.String

EXPORT_PNG

Engine creates PNG output.

Declaration
public const string EXPORT_PNG = "png"
Field Value
Type Description
System.String

EXPORT_PS

Engine creates postscript output.

Declaration
public const string EXPORT_PS = "ps"
Field Value
Type Description
System.String

EXPORT_PS2

Engine creates postscript 2 output.

Declaration
public const string EXPORT_PS2 = "ps2"
Field Value
Type Description
System.String

EXPORT_PS3

Engine creates postscript 3 output.

Declaration
public const string EXPORT_PS3 = "ps3"
Field Value
Type Description
System.String

EXPORT_RTF

Engine creates RTF output.

Declaration
public const string EXPORT_RTF = "rtf"
Field Value
Type Description
System.String

EXPORT_SVG

Engine creates SVG output.

Declaration
public const string EXPORT_SVG = "svg"
Field Value
Type Description
System.String

EXPORT_TXT

Engine creates plain text output.

Declaration
public const string EXPORT_TXT = "txt"
Field Value
Type Description
System.String

EXPORT_XLS

Engine creates XLS output.

Declaration
public const string EXPORT_XLS = "xls"
Field Value
Type Description
System.String

EXPORT_XLSX

Engine creates XLSX output.

Declaration
public const string EXPORT_XLSX = "xlsx"
Field Value
Type Description
System.String

EXPORT_XML

Engine creates XML output.

Declaration
public const string EXPORT_XML = "xml"
Field Value
Type Description
System.String

Properties

DocumentPageCount

Get the number of visual pages in the finally document. This method is waiting until the rendering process has been finished.

Declaration
public int DocumentPageCount { get; }
Property Value
Type Description
System.Int32

PageCount

Get the number of pages/chunck (byte arrays in that the report will be streamed to the client) of the report. This method is waiting until the rendering process has been finished.

Declaration
public int PageCount { get; }
Property Value
Type Description
System.Int32

ReportFile

The report template file.

Declaration
public string ReportFile { get; set; }
Property Value
Type Description
System.String

ReportProperties

The report global properties.

Declaration
public ReportProperties ReportProperties { get; }
Property Value
Type Description
ReportProperties

Methods

Execute()

Executes the report and stores the result data in an internal cache. Before you can execute the report generation you need to set all options. You need to call this method before you can request the page data with PageData(Int32).

Declaration
public void Execute()

GetAvailablePrinters()

Get a list of available printers on the system. This method is waiting until the list is available.

Declaration
public List<string> GetAvailablePrinters()
Returns
Type Description
System.Collections.Generic.List<System.String>

PageData(Int32)

Get a single chunk of page data.

Declaration
public byte[] PageData(int page)
Parameters
Type Name Description
System.Int32 page

The number of the page. The first page is 1, the second is 2, ... . If the page number is bigger than the PageCount then null will be returned.
Returns
Type Description
System.Byte[]

The data of the page chunk or null if not exists.

Print(String)

Prints to engine to the specified printer. This method will not wait for the print to finished.

Declaration
public void Print(string printer)
Parameters
Type Name Description
System.String printer

the name of the printer to use

Prompt(String, String)

Specifies the value for a parameter field in the report. If the name is not in the parameter list the call is ignored.

Declaration
public void Prompt(string name, string value)
Parameters
Type Name Description
System.String name

the name of the parameter
System.String value

the value

SetData(String[], Object[][])

Sets the report data with external data without the use of a JDBC driver.

Declaration
public void SetData(string[] columns, object[][] data)
Parameters
Type Name Description
System.String[] columns

The names of the columns in the report template. This names are by default case in-sensitiv.
System.Object[][] data

the report data. Supported values/types are null, byte, sbyte, short, int, long, float, double, decimal, bool, string, DateTime, TimeSpan and byte[]