Report.Render Method

Processes the report and renders it in the specified format.

Namespace: Microsoft.Reporting.WinForms
Assembly: Microsoft.ReportViewer.WinForms (in microsoft.reportviewer.winforms.dll)

Syntax

'Declaration
Public MustOverride Function Render ( _
    format As String, _
    deviceInfo As String, _
    <OutAttribute> ByRef mimeType As String, _
    <OutAttribute> ByRef encoding As String, _
    <OutAttribute> ByRef fileNameExtension As String, _
    <OutAttribute> ByRef streams As String(), _
    <OutAttribute> ByRef warnings As Warning() _
) As Byte()

'Usage
Dim instance As Report
Dim format As String
Dim deviceInfo As String
Dim mimeType As String
Dim encoding As String
Dim fileNameExtension As String
Dim streams As String()
Dim warnings As Warning()
Dim returnValue As Byte()

returnValue = instance.Render(format, deviceInfo, mimeType, encoding, fileNameExtension, streams, warnings)

public abstract byte[] Render (
    string format,
    string deviceInfo,
    out string mimeType,
    out string encoding,
    out string fileNameExtension,
    out string[] streams,
    out Warning[] warnings
)

public:
virtual array<unsigned char>^ Render (
    String^ format, 
    String^ deviceInfo, 
    [OutAttribute] String^% mimeType, 
    [OutAttribute] String^% encoding, 
    [OutAttribute] String^% fileNameExtension, 
    [OutAttribute] array<String^>^% streams, 
    [OutAttribute] array<Warning^>^% warnings
) abstract

public abstract byte[] Render (
    String format, 
    String deviceInfo, 
    /** @attribute OutAttribute() */ /** @ref */ String mimeType, 
    /** @attribute OutAttribute() */ /** @ref */ String encoding, 
    /** @attribute OutAttribute() */ /** @ref */ String fileNameExtension, 
    /** @attribute OutAttribute() */ /** @ref */ String[] streams, 
    /** @attribute OutAttribute() */ /** @ref */ Warning[] warnings
)

JScript does not support passing value-type arguments by reference.

Parameters

• format
  The format in which to render the report. This argument maps to a rendering extension. Supported extensions include XML, NULL, CSV, IMAGE, PDF, HTML4.0, HTML3.2, MHTML, Excel, and HTMLOWC.

• deviceInfo
  An XML string that contains the device-specific content that is required by the rendering extension specified in the format parameter. For more information about device information settings for specific output formats, see "Device Information Settings" in the SQL Server 2005 Reporting Services documentation.

• mimeType
  [out] The MIME type of the rendered report.

• encoding
  [out] The encoding used when rendering the contents of the report.

• fileNameExtension
  [out] The filename extension used for the output file.

• streams
  [out] The stream identifiers. You can use them to render the external resources (images, etc.) that are associated with the report.

• warnings
  [out] An array of Warning objects that describes any warnings that occurred during report processing.

Return Value

A Byte array of the report in the specified format.

Remarks

Please see the LocalReport or ServerReport implementations for specific remarks and code samples.

See Also

Reference

Report Class
Report Members
Microsoft.Reporting.WinForms Namespace