Progress® Telerik® Reporting R2 2019

Embedded Report Engine

Requirements

To export a report, you can use the RenderReport method of the ReportProcessor class. This method converts the contents of the report to a byte array in the specified format, which you can then use with other classes such as MemoryStream or FileStream .

The RenderReport method has two overloads, the first is used when rendering a single stream, the second when rendering multiple streams. The available extensions used as first argument of the RenderReport method are listed in the Rendering Extensions article.

Exporting a report to a single document format

Some formats (MHTML, PDF, XLS(X), RTF, DOCX, PPTX, CSV) produce a single document which is handled by the first overload of the RenderReport:

Example

var reportProcessor = new Telerik.Reporting.Processing.ReportProcessor();

// set any deviceInfo settings if necessary
var deviceInfo = new System.Collections.Hashtable();

// Depending on the report definition choose ONE of the following REPORT SOURCES
//                  -1-
// ***CLR (CSharp) report definitions***
var reportSource = new Telerik.Reporting.TypeReportSource();

// reportName is the Assembly Qualified Name of the report
reportSource.TypeName = reportName;
//                  -1-

////                  -2-
//// ***Declarative (TRDP/TRDX) report definitions***
//var reportSource = new Telerik.Reporting.UriReportSource();

//// reportName is the path to the TRDP/TRDX file
//reportSource.Uri = reportName;
////                  -2-

////                  -3-
//// ***Instance of the report definition***
//var reportSource = new Telerik.Reporting.InstanceReportSource();

//// Report1 is the class of the report. It should inherit Telerik.Reporting.Report class
//reportSource.ReportDocument = new Report1();
////                  -3-

Telerik.Reporting.Processing.RenderingResult result = reportProcessor.RenderReport("PDF", reportSource, deviceInfo);

// Pass parameter value with the Report Source if necessary
object parameterValue = "Some Parameter Value";
reportSource.Parameters.Add("ParameterName", parameterValue);

string fileName = result.DocumentName + "." + result.Extension;
string path = System.IO.Path.GetTempPath();
string filePath = System.IO.Path.Combine(path, fileName);

using (System.IO.FileStream fs = new System.IO.FileStream(filePath, System.IO.FileMode.Create))
{
    fs.Write(result.DocumentBytes, 0, result.DocumentBytes.Length);
}

When you export programmatically to XPS, you should use a separate STA thread which is required by the underlying WPF UI elements that we use to create the XAML representation of the report.

Exporting a report to a multi document format

Some formats produce multiple files, for example HTML outputs all pages and related resources (images) in separate streams. In order to render a report in a non-single document format (HTML and IMAGE except TIFF) one should use the second RenderReport overload that accepts a CreateStream callback. For this example we're going to render to JPEG, but you can render a report in all graphic formats that GDI+ supports natively - this includes BMP, GIF, JPEG, PNG, TIFF and metafile (EMF). The Windows Forms Application uses internally metafile for rendering the reports for viewing, and TIFF for exporting. The rest of the formats are available only through code using the ReportProcessor.Render method where you should specify "IMAGE" as export format and the additional output format that is the actual graphic format - BMP, GIF, JPEG. Here is an example that renders a report as a JPEG image:

Example

System.Collections.Generic.List<System.IO.Stream> streams =
    new System.Collections.Generic.List<System.IO.Stream>();

public bool RenderReport(string reportName)
{
    Telerik.Reporting.Processing.ReportProcessor reportProcessor = new Telerik.Reporting.Processing.ReportProcessor();

    string documentName = "";

    // specify the output format of the produced image.
    var deviceInfo = new System.Collections.Hashtable();

    deviceInfo["OutputFormat"] = "JPEG";


    // Depending on the report definition choose ONE of the following REPORT SOURCES
    //                  -1-
    // ***CLR (CSharp) report definitions***
    var reportSource = new Telerik.Reporting.TypeReportSource();

    // reportName is the Assembly Qualified Name of the report
    reportSource.TypeName = reportName;
    //                  -1-

    ////                  -2-
    //// ***Declarative (TRDP/TRDX) report definitions***
    //var reportSource = new Telerik.Reporting.UriReportSource();

    //// reportName is the path to the TRDP/TRDX file
    //reportSource.Uri = reportName;
    ////                  -2-

    ////                  -3-
    //// ***Instance of the report definition***
    //var reportSource = new Telerik.Reporting.InstanceReportSource();

    //// Report1 is the class of the report. It should inherit Telerik.Reporting.Report class
    //reportSource.ReportDocument = new Report1();
    ////                  -3-

    // Pass parameter value with the Report Source if necessary
    object parameterValue = "Some Parameter Value";
    reportSource.Parameters.Add("ParameterName", parameterValue);

    bool result = reportProcessor.RenderReport("IMAGE", reportSource, deviceInfo, this.CreateStream, out documentName);

    this.CloseStreams();

    return result;
}

void CloseStreams()
{
    foreach (System.IO.Stream stream in this.streams)
    {
        stream.Close();
    }
    this.streams.Clear();
}

System.IO.Stream CreateStream(string name, string extension, System.Text.Encoding encoding, string mimeType)
{
    string path = System.IO.Path.GetTempPath();
    string filePath = System.IO.Path.Combine(path, name + "." + extension);

    System.IO.FileStream fs = new System.IO.FileStream(filePath, System.IO.FileMode.Create);
    this.streams.Add(fs);
    return fs;
}

See Also

Reference

In this article
Not finding the help you need?