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

Processes the report with a specified page count mode and renders it in the specified format.

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

Syntax

'Declaration
Public Overrides 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 LocalReport
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 override 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
) override

public 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 argument maps to a rendering extension. Supported formats include Excel, PDF, Word, and Image.

  To access the list of available rendering extensions, use the ListRenderingExtensions method.

• 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 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 and rendering.

Return Value

A Byte array of the report in the specified format.

Remarks

This method can be used to export and print a report.

After this method completes successfully, the value of pageCountMode determines the default page count mode the LocalReport object uses when you call the GetTotalPages method. For more information, see GetTotalPages.

See Also

Reference

LocalReport Class
LocalReport Members
Microsoft.Reporting.WinForms Namespace