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

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

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

Syntax

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

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

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

Parameters

• format
  Type: System.String

  The format in which to render the report. This argument maps to a rendering extension. You can use any formatting extension available on the report server.

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

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

• pageCountMode
  Type: Microsoft.Reporting.WinForms.PageCountMode

  A PageCountMode enumeration value that specifies the page count mode.

• 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 file name extension used for the output file.

• streams
  Type: System.String[]

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

• warnings
  Type: Microsoft.Reporting.WinForms.Warning[]

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

Return Value

Type: System.Byte[]

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 ServerReport object uses when you call the M:Microsoft.Reporting.WinForms.ServerReport.GetTotalPages method. For more information, see GetTotalPages.

See Also

Render Overload
ServerReport Class
Microsoft.Reporting.WinForms Namespace

Return to top