LocalReport.Render Method (String, String, PageCountMode, CreateStreamCallback, Warning[])
Processes the report with a specified page count mode and renders it in the specified format using a stream provided by a callback function.
Namespace: Microsoft.Reporting.WinForms
Assembly: Microsoft.ReportViewer.WinForms (in Microsoft.ReportViewer.WinForms.dll)
Syntax
public void Render(
string format,
string deviceInfo,
PageCountMode pageCountMode,
CreateStreamCallback createStream,
out Warning[] warnings
)
public:
void Render(
String^ format,
String^ deviceInfo,
PageCountMode pageCountMode,
CreateStreamCallback^ createStream,
[OutAttribute] array<Warning^>^% warnings
)
member Render :
format:string *
deviceInfo:string *
pageCountMode:PageCountMode *
createStream:CreateStreamCallback *
warnings:Warning[] byref -> unit
Public Sub Render (
format As String,
deviceInfo As String,
pageCountMode As PageCountMode,
createStream As CreateStreamCallback,
<OutAttribute> ByRef warnings As Warning()
)
Parameters
format
Type: System.StringThe 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
Type: System.StringAn 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.PageCountModeA PageCountMode enumeration value that specifies the page count mode.
createStream
Type: Microsoft.Reporting.WinForms.CreateStreamCallbackA CreateStreamCallback delegate function that will be used to provide a Stream object for rendering.
warnings
Type: Microsoft.Reporting.WinForms.Warning[][out] An array of Warning objects that describes any warnings that occurred during report processing and rendering.
Remarks
This method accepts a CreateStreamCallback delegate function in the createStream parameter to support custom handling of secondary streams. This method is useful for printing.
After this method completes successfully, the value of pageCountMode will be the default page count mode the LocalReport object uses when you call the M:Microsoft.Reporting.WinForms.LocalReport.GetTotalPages method. For more information, see GetTotalPages.
See Also
Render Overload
LocalReport Class
Microsoft.Reporting.WinForms Namespace
Return to top