ServerReport Class

Article
09/02/2015

Represents a report that is processed on the report server.

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

Inheritance Hierarchy

System.Object
Microsoft.Reporting.WinForms.Report
Microsoft.Reporting.WinForms.ServerReport

Syntax

[SerializableAttribute]
public sealed class ServerReport : Report, ISerializable

[SerializableAttribute]
public ref class ServerReport sealed : Report, ISerializable

[<Sealed>]
[<SerializableAttribute>]
type ServerReport = 
    class
        inherit Report
        interface ISerializable
    end

<SerializableAttribute>
Public NotInheritable Class ServerReport
    Inherits Report
    Implements ISerializable

Constructors

	Name	Description
	ServerReport()	Initializes a new instance of the ServerReport class.

Properties

	Name	Description
	Cookies	Gets a collection of Cookie objects. The ServerReport object uses the cookies in this collection when making server requests.
	DisplayName	Gets or sets the display name of the report.(Inherited from Report.)
	Headers	Gets a collection of strings that contain custom headers.
	HistoryId	Gets or sets the unique identifier of the report history snapshot used for the server report.
	IsDrillthroughReport	Indicates whether the report is a drillthrough report.(Inherited from Report.)
	IsReadyForRendering	Gets a Boolean value that indicates whether a report definition and all required parameters have been specified, and all data sources are ready for use. (Inherited from Report.)
	ReportPath	Gets or sets the path to the report on the server.
	ReportServerCredentials	Gets the credentials to be used with the report server.
	ReportServerUrl	Gets or sets the URL for the report server.
	Timeout	Gets or sets the number of milliseconds to wait for server communications.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetDataSources()	Retrieves information about the data sources used for a report.
	GetDataSources(Boolean)	Retrieves information about the data sources used for a report, including whether all required credentials have been supplied for the report data sources.
	GetDefaultPageSettings()	Gets the default page settings specified in the report definition.(Overrides Report.GetDefaultPageSettings().)
	GetDocumentMap()	Returns the representation of the document map for the local report.(Inherited from Report.)
	GetExecutionId()	Returns the current execution ID, or null (Nothing in Visual Basic) if no execution ID is available.
	GetHashCode()	(Inherited from Object.)
	GetParameters()	Returns report parameter properties for the report.(Overrides Report.GetParameters().)
	GetServerVersion()	Returns the version of the report server.
	GetTotalPages()	Returns the total number of soft pages in the report. (Inherited from Report.)
	GetTotalPages(PageCountMode)	Returns the total number of soft pages in the report and a PageCountMode value that indicates the current page count mode.(Overrides Report.GetTotalPages(PageCountMode).)
	GetType()	(Inherited from Object.)
	IsQueryExecutionAllowed()	Indicates whether the report can execute queries.
	ListRenderingExtensions()	Returns all available rendering extensions for the server report.(Overrides Report.ListRenderingExtensions().)
	LoadReportDefinition(Stream)	Loads a report definition for processing using a Stream.(Inherited from Report.)
	LoadReportDefinition(TextReader)	Loads the report definition on the report server for remote processing using a TextReader.(Overrides Report.LoadReportDefinition(TextReader).)
	Refresh()	Causes the report to be rendered with new data.(Overrides Report.Refresh().)
	Render(String)	Processes the report and renders it in the specified format.(Inherited from Report.)
	Render(String, String)	Processes the report and renders it in the specified format.(Inherited from Report.)
	Render(String, String, NameValueCollection, Stream, String, String)	Renders the report with optional URL access parameters.
	Render(String, String, NameValueCollection, String, String)	Renders the report with optional URL access parameters.
	Render(String, String, PageCountMode, String, String, String, String[], Warning[])	Processes the report with the specified PageCountMode valuevalue and renders it in the specified format.(Overrides Report.Render(String, String, PageCountMode, String, String, String, String[], Warning[]).)
	Render(String, String, String, String, String, String[], Warning[])	Processes the report and renders it in the specified format.(Inherited from Report.)
	RenderStream(String, String, String, String, String)	Returns a secondary stream associated with a processed report.
	SetDataSourceCredentials(IEnumerable<DataSourceCredentials>)	Sets data source credentials for the report.
	SetExecutionId(String)	Initializes a server report using a specific report execution on the server.
	SetParameters(IEnumerable<ReportParameter>)	Sets report parameter properties for the report.(Overrides Report.SetParameters(IEnumerable<ReportParameter>).)
	SetParameters(ReportParameter)	Sets report parameter properties for the report.(Inherited from Report.)
	ToString()	(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Remarks

The ServerReport object serves as a proxy for a report on a report server. It processes reports at the report server, rather than locally. It can open Report Definition Language (RDL) files that have been published to the server, and it can also load a report definition from a Stream or a TextReader to the server for remote processing.

The ServerReport object exposes additional functionality supported by the report server, including parameters, and the ability to export reports to any format supported by the report server.

The ServerReport object requires a SQL Server 2008 version of Reporting Services, or later.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.