Report.Render Method

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

Namespace:  Microsoft.ReportingServices.Interfaces
Assemblies:   Microsoft.ReportingServices.SharePoint.UI.WebParts (in Microsoft.ReportingServices.SharePoint.UI.WebParts.dll)
  Microsoft.ReportingServices.Interfaces (in Microsoft.ReportingServices.Interfaces.dll)

Syntax

'Declaration
Public MustOverride Function Render ( _
    renderFormat As String, _
    deviceInfo As String _
) As RenderedOutputFile()
'Usage
Dim instance As Report
Dim renderFormat As String
Dim deviceInfo As String
Dim returnValue As RenderedOutputFile()

returnValue = instance.Render(renderFormat, _
    deviceInfo)
public abstract RenderedOutputFile[] Render(
    string renderFormat,
    string deviceInfo
)
public:
virtual array<RenderedOutputFile^>^ Render(
    String^ renderFormat, 
    String^ deviceInfo
) abstract
abstract Render : 
        renderFormat:string * 
        deviceInfo:string -> RenderedOutputFile[] 
public abstract function Render(
    renderFormat : String, 
    deviceInfo : String
) : RenderedOutputFile[]

Parameters

  • renderFormat
    Type: System.String
    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
    Type: System.String
    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

Type: array<Microsoft.ReportingServices.Interfaces.RenderedOutputFile[]
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).