ReportViewer Members

Article
04/11/2011

Encapsulates the methods and properties used for the ReportViewer control.

The following tables list the members exposed by the ReportViewer type.

Public Constructors

	Name	Description
	ReportViewer	Initializes a new instance of the ReportViewer class.

Top

Public Fields

	Name	Description
	MaximumPageCount	A constant that represents the maximum number of pages in a report when the current page count mode is Estimate.

Top

Public Properties

(see also Protected Properties )

	Name	Description
	AccessKey	(Inherited from WebControl.)
	AppRelativeTemplateSourceDirectory	(Inherited from Control.)
	AsyncRendering	Gets or sets a Boolean value that indicates whether the report is rendered asynchronously from the rest of the Web page when the Web page is being loaded.
	Attributes	(Inherited from WebControl.)
	BackColor	Overridden. Gets or sets the background color of the control's report area.
	BindingContainer	(Inherited from Control.)
	BorderColor	(Inherited from WebControl.)
	BorderStyle	(Inherited from WebControl.)
	BorderWidth	(Inherited from WebControl.)
	ClientID	(Inherited from Control.)
	ClientIDMode	(Inherited from Control.)
	Controls	(Inherited from CompositeControl.)
	ControlStyle	(Inherited from WebControl.)
	ControlStyleCreated	(Inherited from WebControl.)
	CssClass	(Inherited from WebControl.)
	CurrentPage	Gets or sets the current page of the ReportViewer control's active report.
	DataItemContainer	(Inherited from Control.)
	DataKeysContainer	(Inherited from Control.)
	DisabledCssClass	(Inherited from WebControl.)
	DocumentMapCollapsed	Gets or sets the collapsed state of the document map.
	DocumentMapWidth	Gets or sets the width of the document map.
	Enabled	(Inherited from WebControl.)
	EnableTheming	(Inherited from WebControl.)
	EnableViewState	(Inherited from Control.)
	ExportContentDisposition	Gets or sets a value that indicates whether content should be present in-line or as an attachment.
	Font	(Inherited from WebControl.)
	ForeColor	(Inherited from WebControl.)
	HasAttributes	(Inherited from WebControl.)
	Height	Overridden. Gets or sets the height of the control.
	HyperlinkTarget	Gets or sets the target window or frame for the Web page content that is returned when a hyperlink in the report is clicked.
	ID	Overridden. Specifies the ID of the control.
	InteractiveDeviceInfos	Gets the DeviceInfoCollection object that the ReportViewer control uses to render the report in the report area as HTML.
	InteractivityPostBackMode	Gets or sets an InteractivityPostBackMode value that indicates the postback mode of the ReportViewer control.
	InternalBorderColor	Gets or sets the internal border color of the control.
	InternalBorderStyle	Gets or sets the internal border style of the control.
	InternalBorderWidth	Gets or sets the width of the internal border of the control.
	KeepSessionAlive	Gets or sets a Boolean value that indicates whether to keep the user session from expiring as long as the Web page is displayed in the browser.
	LinkActiveColor	Gets or sets the color of an active link in the control.
	LinkActiveHoverColor	Gets or sets the color of the active link in the control while the mouse pointer is over the link.
	LinkDisabledColor	Gets or sets the color of a disabled link in the control.
	LocalReport	Gets the instance of the Report class that is used when the ProcessingMode for the ReportViewer control is set to Local.
	NamingContainer	(Inherited from Control.)
	Page	(Inherited from Control.)
	PageCountMode	Gets or sets a PageCountMode enumeration value that indicates the default page count mode to use when rendering a report in the report area.
	Parent	(Inherited from Control.)
	ProcessingMode	Gets or sets the processing mode of the ReportViewer control.
	PromptAreaCollapsed	Gets or sets the collapsed state of the parameter prompt area or the credentials prompt area.
	RenderingCompatibility	(Inherited from Control.)
	ReportAreaContentType	Gets a ReportAreaContent object that indicates the current content type of the report area.
	SearchState	Gets the search text and the start page of the current report search operation.
	ServerReport	Gets the instance of the Report class that is used when the ProcessingMode for the ReportViewer control is set to Remote.
	ShowBackButton	Gets or sets a value that indicates whether the Back button is visible on the toolbar.
	ShowCredentialPrompts	Gets or sets a value that indicates whether to display a prompt for user credentials.
	ShowDocumentMapButton	Gets or sets a value that indicates whether the button that shows and collapses the document map is visible on the split bar.
	ShowExportControls	Gets or sets a value that indicates whether the Export control is visible on the toolbar.
	ShowFindControls	Gets or sets a value that indicates whether the Find text box is visible on the toolbar.
	ShowPageNavigationControls	Gets or sets a value that indicates whether the page navigation controls are visible on the toolbar.
	ShowParameterPrompts	Gets or sets a value that indicates whether parameter prompts are displayed.
	ShowPrintButton	Gets or sets a value that indicates whether Print button is visible on the toolbar.
	ShowPromptAreaButton	Gets or sets a value that indicates whether the button that shows and collapses the prompt area is visible on the split bar.
	ShowRefreshButton	Gets or sets a value that indicates whether the Refresh button is visible.
	ShowReportBody	Gets or sets a value that indicates whether the report body is visible on the control.
	ShowToolBar	Gets or sets a value that indicates whether the toolbar is visible on the control.
	ShowWaitControlCancelLink	Gets or sets a Boolean value that controls whether to display the Cancel link in the wait control.
	ShowZoomControl	Gets or sets a value that indicates whether the Zoom list box is visible.
	Site	(Inherited from Control.)
	SizeToReportContent	Gets or sets a value that indicates whether the ReportViewer control should automatically resize to accommodate report content.
	SkinID	(Inherited from WebControl.)
	SplitterBackColor	Gets or sets the background color of the document map split bar and the prompt area split bar.
	Style	(Inherited from WebControl.)
	SupportsDisabledAttribute	(Inherited from CompositeControl.)
	TabIndex	(Inherited from WebControl.)
	TemplateControl	(Inherited from Control.)
	TemplateSourceDirectory	(Inherited from Control.)
	ToolBarItemBorderColor	Gets or sets the border color of an item on the toolbar.
	ToolBarItemBorderStyle	Gets or sets the border style of an item on the toolbar.
	ToolBarItemBorderWidth	Gets or sets the width of the toolbar item border.
	ToolBarItemHoverBackColor	Gets or sets the background color of toolbar item while the mouse pointer is over the item.
	ToolBarItemPressedBorderColor	This property is no longer applicable and exists for backward compatibility. ReportViewer control no longer uses pressed buttons. Obsolete.
	ToolBarItemPressedBorderStyle	This property is no longer applicable and exists for backward compatibility. The ReportViewer control no longer uses pressed buttons. Obsolete.
	ToolBarItemPressedBorderWidth	This property is no longer applicable and exists for backward compatibility. The ReportViewer control no longer uses pressed buttons. Obsolete.
	ToolBarItemPressedHoverBackColor	This property is no longer applicable and exists for backward compatibility. The ReportViewer control no longer uses pressed buttons. Obsolete.
	ToolTip	(Inherited from WebControl.)
	UniqueID	(Inherited from Control.)
	ViewStateMode	(Inherited from Control.)
	Visible	(Inherited from Control.)
	WaitControlDisplayAfter	Gets or sets the delay in milliseconds before the wait control is displayed to the user when the report is loaded.
	WaitMessageFont	Gets the font for the message that is displayed while the report is being executed.
	Width	Overridden. Gets or sets the width of the control.
	ZoomMode	Gets or sets the zoom mode of the control.
	ZoomPercent	Gets or sets the zoom percentage to use when displaying the report.

Top

Protected Properties

	Name	Description
	Adapter	(Inherited from Control.)
	ChildControlsCreated	(Inherited from Control.)
	ClientIDSeparator	(Inherited from Control.)
	Context	(Inherited from Control.)
	DesignMode	(Inherited from Control.)
	Events	(Inherited from Control.)
	HasChildViewState	(Inherited from Control.)
	IdSeparator	(Inherited from Control.)
	IsChildControlStateCleared	(Inherited from Control.)
	IsEnabled	(Inherited from WebControl.)
	IsTrackingViewState	(Inherited from Control.)
	IsViewStateEnabled	(Inherited from Control.)
	LoadViewStateByID	(Inherited from Control.)
	TagKey	Overridden.
	TagName	(Inherited from WebControl.)
	ViewState	(Inherited from Control.)
	ViewStateIgnoresCase	(Inherited from Control.)

Top

Public Methods

(see also Protected Methods )

	Name	Description
	ApplyStyle	(Inherited from WebControl.)
	ApplyStyleSheetSkin	(Inherited from Control.)
	CopyBaseAttributes	(Inherited from WebControl.)
	DataBind	Overloaded. (Inherited from CompositeControl.)
	Dispose	Overridden.
	Equals	Overloaded. (Inherited from Object.)
	Find	Searches the report in the report area for the specified text string, starting from the specified page number.
	FindControl	Overloaded. (Inherited from Control.)
	Focus	(Inherited from Control.)
	GetHashCode	(Inherited from Object.)
	GetPageSettings	Returns the page settings that are used to print the current report in the ReportViewer control.
	GetRouteUrl	Overloaded. (Inherited from Control.)
	GetType	(Inherited from Object.)
	GetUniqueIDRelativeTo	(Inherited from Control.)
	HasControls	(Inherited from Control.)
	JumpToBookmark	Moves the focus of the report to the specified bookmark.
	JumpToDocumentMapId	Moves the focus of the document map to the specified node.
	MergeStyle	(Inherited from WebControl.)
	PerformBack	Navigates the ReportViewer control back to the parent report from a drillthrough report.
	ReferenceEquals	(Inherited from Object.)
	RegisterPostBackControl	Registers the specified control with the ReportViewer control. The ReportViewer control displays the wait control when the registered control causes a postback.
	RenderBeginTag	(Inherited from WebControl.)
	RenderControl	Overloaded. (Inherited from Control.)
	RenderEndTag	(Inherited from WebControl.)
	Reset	Resets the control to its default values.
	ResetPageSettings	Reverts the page settings for the current report in the ReportViewer control to the settings in the report definition.
	ResolveClientUrl	(Inherited from Control.)
	ResolveUrl	(Inherited from Control.)
	SetPageSettings	Sets the page settings that are used to print the current report in the ReportViewer control.
	SetRenderMethodDelegate	(Inherited from Control.)
	ToString	(Inherited from Object.)

Top

Protected Methods

	Name	Description
	AddAttributesToRender	(Inherited from WebControl.)
	AddedControl	(Inherited from Control.)
	AddParsedSubObject	(Inherited from Control.)
	BuildProfileTree	(Inherited from Control.)
	ClearCachedClientID	(Inherited from Control.)
	ClearChildControlState	(Inherited from Control.)
	ClearChildState	(Inherited from Control.)
	ClearChildViewState	(Inherited from Control.)
	ClearEffectiveClientIDMode	(Inherited from Control.)
	CreateChildControls	Overridden.
	CreateControlCollection	(Inherited from Control.)
	CreateControlStyle	Overridden.
	DataBind	Overloaded. (Inherited from Control.)
	DataBindChildren	(Inherited from Control.)
	EnsureChildControls	(Inherited from Control.)
	EnsureID	(Inherited from Control.)
	Finalize	(Inherited from Object.)
	FindControl	Overloaded. (Inherited from Control.)
	GetDesignModeState	(Inherited from Control.)
	HasEvents	(Inherited from Control.)
	IsLiteralContent	(Inherited from Control.)
	LoadControlState	(Inherited from Control.)
	LoadViewState	Overridden.
	MapPathSecure	(Inherited from Control.)
	MemberwiseClone	(Inherited from Object.)
	OnBubbleEvent	(Inherited from Control.)
	OnDataBinding	(Inherited from Control.)
	OnInit	Overridden.
	OnLoad	(Inherited from Control.)
	OnPreRender	Overridden.
	OnUnload	(Inherited from Control.)
	OpenFile	(Inherited from Control.)
	RaiseBubbleEvent	(Inherited from Control.)
	RecreateChildControls	(Inherited from CompositeControl.)
	RemovedControl	(Inherited from Control.)
	Render	Overridden.
	RenderChildren	(Inherited from Control.)
	RenderContents	(Inherited from WebControl.)
	RenderControl	Overloaded. (Inherited from Control.)
	ResolveAdapter	(Inherited from Control.)
	SaveControlState	(Inherited from Control.)
	SaveViewState	Overridden.
	SetDesignModeState	(Inherited from Control.)
	TrackViewState	(Inherited from WebControl.)

Top

Public Events

	Name	Description
	Back	Occurs when a user navigates from a drillthrough report back to the parent report.
	BookmarkNavigation	Occurs when a user browses to a bookmark in a report.
	DataBinding	(Inherited from Control.)
	Disposed	(Inherited from Control.)
	DocumentMapNavigation	Occurs when a document map node is selected.
	Drillthrough	Occurs when a drillthrough item is selected.
	Init	(Inherited from Control.)
	Load	(Inherited from Control.)
	PageNavigation	Occurs when a user moves to a different page in a report.
	PreRender	(Inherited from Control.)
	ReportError	Occurs when an error is found in the report.
	ReportRefresh	Occurs when the report is refreshed.
	Search	Occurs when the Find or Find Next button is clicked, or when a search operation is invoked programmatically.
	Sort	Occurs when the user activates a sort on the report data.
	SubmittingDataSourceCredentials	Occurs when the user submits new data source credentials using the data source prompt area.
	SubmittingParameterValues	Occurs when report parameter values are submitted to the report server.
	Toggle	Occurs when the user toggles the visibility of an item in the report.
	Unload	(Inherited from Control.)

Top

Explicit Interface Implementations

	Name	Description
	System.Web.UI.IAttributeAccessor.GetAttribute	(Inherited from WebControl.)
	System.Web.UI.IAttributeAccessor.SetAttribute	(Inherited from WebControl.)
	System.Web.UI.IControlDesignerAccessor.GetDesignModeState	(Inherited from Control.)
	System.Web.UI.IControlDesignerAccessor.SetDesignModeState	(Inherited from Control.)
	System.Web.UI.IControlDesignerAccessor.SetOwnerControl	(Inherited from Control.)
	System.Web.UI.IParserAccessor.AddParsedSubObject	(Inherited from Control.)
	System.Web.UI.IScriptControl.GetScriptDescriptors
	System.Web.UI.IScriptControl.GetScriptReferences
	System.Web.UI.WebControls.ICompositeControlDesignerAccessor.RecreateChildControls	(Inherited from CompositeControl.)
	System.Web.UI.IControlBuilderAccessor.ControlBuilder	(Inherited from Control.)
	System.Web.UI.IControlDesignerAccessor.UserData	(Inherited from Control.)
	System.Web.UI.IDataBindingsAccessor.DataBindings	(Inherited from Control.)
	System.Web.UI.IDataBindingsAccessor.HasDataBindings	(Inherited from Control.)
	System.Web.UI.IExpressionsAccessor.Expressions	(Inherited from Control.)
	System.Web.UI.IExpressionsAccessor.HasExpressions	(Inherited from Control.)

Top