Report.Render Method (String, String, PageCountMode, out String, out String, out String, out String[], out Warning )

Processes the report with the specified PageCountMode value and renders it in the specified format.

Namespace: Microsoft.Reporting.WebForms
Assembly: Microsoft.ReportViewer.WebForms (in microsoft.reportviewer.webforms.dll)

Syntax

'Declaration
Public MustOverride Function Render ( _
    format As String, _
    deviceInfo As String, _
    pageCountMode As PageCountMode, _
    <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 pageCountMode As PageCountMode
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, pageCountMode, mimeType, encoding, fileNameExtension, streams, warnings)

public abstract byte[] Render (
    string format,
    string deviceInfo,
    PageCountMode pageCountMode,
    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, 
    PageCountMode pageCountMode, 
    [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, 
    PageCountMode pageCountMode, 
    /** @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 parameter maps to a rendering extension.

  In local processing mode, supported extensions are Excel, PDF, Word, and Image. In remote processing mode, supported extensions depend on the extensions supported by the report server.

  You can access the list of available rendering extensions using the ListRenderingExtensions method in ServerReport or LocalReport, depending on the processing mode (see ProcessingMode).

• 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 SQL Server Books Online.

• pageCountMode
  A PageCountMode enumeration value that specifies the page count mode.

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

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

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

• streams
  [out] The stream identifiers. You can use them to render the external resources (images, for example) 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

See the GetTotalPages method for the effects of the pageCountMode parameter on the total number of pages.

See Also

Reference

Report Class
Report Members
Microsoft.Reporting.WebForms Namespace