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

  • Article

 

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

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

Syntax

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

abstract Render : 
        format:string *
        deviceInfo:string *
        pageCountMode:PageCountMode *
        mimeType:string byref *
        encoding:string byref *
        fileNameExtension:string byref *
        streams:string[] byref *
        warnings:Warning[] byref -> byte[]

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()

Parameters

  • format
    Type: System.String

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

    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 fe718939-7efe-4c7f-87cb-5f5b09caeff4 Device Information Settings in SQL Server Books Online.

  • mimeType
    Type: System.String

    [out] The MIME type of the rendered report.

  • encoding
    Type: System.String

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

  • fileNameExtension
    Type: System.String

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

  • streams
    Type: System.String[]

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

Return Value

Type: System.Byte[]

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

Render Overload
Report Class
Microsoft.Reporting.WinForms Namespace

Return to top