Report.Render Method

Article
12/03/2008

Renders a report in a specific format using the information stored in the properties of the Report object.

Namespace: Microsoft.ReportingServices.Interfaces
Assembly: Microsoft.ReportingServices.Interfaces (in microsoft.reportingservices.interfaces.dll)

Syntax

'Declaration
Public MustOverride Function Render ( _
    renderFormat As String, _
    deviceInfo As String _
) As RenderedOutputFile()

public abstract RenderedOutputFile[] Render (
    string renderFormat,
    string deviceInfo
)

public:
virtual array<RenderedOutputFile^>^ Render (
    String^ renderFormat, 
    String^ deviceInfo
) abstract

public abstract RenderedOutputFile[] Render (
    String renderFormat, 
    String deviceInfo
)

public abstract function Render (
    renderFormat : String, 
    deviceInfo : String
) : RenderedOutputFile[]

Parameters

renderFormat
The name of the format that is used to render the report. The format corresponds to one of the available rendering extensions installed on the report server.

deviceInfo
An XML string that defines a list of extension parameters for the rendering extension that is used to format the report so that it can be delivered correctly based on the requirements of the delivery extension.

Return Value

An array of RenderedOutputFile objects produced by the rendering extension selected in the renderFormat parameter.

Remarks

The Render method returns an array of one or more RenderedOutputFile objects that together constitute a single rendered report. The first RenderedOutputFile object is the rendered report, whereas any subsequent RenderedOutputFile objects are resources that must be delivered along with the report data (for example, an HTML file and associated images).

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms