ReportViewer Class

 

Encapsulates the methods and properties used for the ReportViewer control.

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


public class ReportViewer : CompositeControl, IScriptControl

NameDescription
System_CAPS_pubmethodReportViewer()

Initializes a new instance of the ReportViewer class.

NameDescription
System_CAPS_pubpropertyAccessKey

(Inherited from WebControl.)

System_CAPS_protpropertyAdapter

(Inherited from Control.)

System_CAPS_pubpropertyAppRelativeTemplateSourceDirectory

(Inherited from Control.)

System_CAPS_pubpropertyAsyncRendering

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.

System_CAPS_pubpropertyAttributes

(Inherited from WebControl.)

System_CAPS_pubpropertyBackColor

Gets or sets the background color of the control's report area.(Overrides WebControl.BackColor.)

System_CAPS_pubpropertyBorderColor

(Inherited from WebControl.)

System_CAPS_pubpropertyBorderStyle

(Inherited from WebControl.)

System_CAPS_pubpropertyBorderWidth

(Inherited from WebControl.)

System_CAPS_protpropertyChildControlsCreated

(Inherited from Control.)

System_CAPS_pubpropertyClientID

(Inherited from Control.)

System_CAPS_protpropertyClientIDSeparator

(Inherited from Control.)

System_CAPS_protpropertyContext

(Inherited from Control.)

System_CAPS_pubpropertyControls

(Inherited from CompositeControl.)

System_CAPS_pubpropertyControlStyle

(Inherited from WebControl.)

System_CAPS_pubpropertyControlStyleCreated

(Inherited from WebControl.)

System_CAPS_pubpropertyCssClass

(Inherited from WebControl.)

System_CAPS_pubpropertyCurrentPage

Gets or sets the current page of the ReportViewer control's active report.

System_CAPS_protpropertyDesignMode

(Inherited from Control.)

System_CAPS_pubpropertyDocumentMapCollapsed

Gets or sets the collapsed state of the document map.

System_CAPS_pubpropertyDocumentMapWidth

Gets or sets the width of the document map.

System_CAPS_pubpropertyEnabled

(Inherited from WebControl.)

System_CAPS_pubpropertyEnableTheming

(Inherited from WebControl.)

System_CAPS_pubpropertyEnableViewState

(Inherited from Control.)

System_CAPS_protpropertyEvents

(Inherited from Control.)

System_CAPS_pubpropertyExportContentDisposition

Gets or sets a value that indicates whether content should be present in-line or as an attachment.

System_CAPS_pubpropertyFont

(Inherited from WebControl.)

System_CAPS_pubpropertyForeColor

(Inherited from WebControl.)

System_CAPS_pubpropertyHasAttributes

(Inherited from WebControl.)

System_CAPS_protpropertyHasChildViewState

(Inherited from Control.)

System_CAPS_pubpropertyHeight

Gets or sets the height of the control.(Overrides WebControl.Height.)

System_CAPS_pubpropertyHyperlinkTarget

Gets or sets the target window or frame for the Web page content that is returned when a hyperlink in the report is clicked.

System_CAPS_pubpropertyID

Specifies the ID of the control.(Overrides Control.ID.)

System_CAPS_protpropertyIdSeparator

(Inherited from Control.)

System_CAPS_pubpropertyInteractiveDeviceInfos

Gets the DeviceInfoCollection object that the ReportViewer control uses to render the report in the report area as HTML.

System_CAPS_pubpropertyInteractivityPostBackMode

Gets or sets an InteractivityPostBackMode value that indicates the postback mode of the ReportViewer control.

System_CAPS_pubpropertyInternalBorderColor

Gets or sets the internal border color of the control.

System_CAPS_pubpropertyInternalBorderStyle

Gets or sets the internal border style of the control.

System_CAPS_pubpropertyInternalBorderWidth

Gets or sets the width of the internal border of the control.

System_CAPS_protpropertyIsChildControlStateCleared

(Inherited from Control.)

System_CAPS_protpropertyIsEnabled

(Inherited from WebControl.)

System_CAPS_protpropertyIsTrackingViewState

(Inherited from Control.)

System_CAPS_protpropertyIsViewStateEnabled

(Inherited from Control.)

System_CAPS_pubpropertyKeepSessionAlive

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.

System_CAPS_pubpropertyLinkActiveColor

Gets or sets the color of an active link in the control.

System_CAPS_pubpropertyLinkActiveHoverColor

Gets or sets the color of the active link in the control while the mouse pointer is over the link.

System_CAPS_pubpropertyLinkDisabledColor

Gets or sets the color of a disabled link in the control.

System_CAPS_protpropertyLoadViewStateByID

(Inherited from Control.)

System_CAPS_pubpropertyLocalReport

Gets the instance of the Report class that is used when the ProcessingMode for the ReportViewer control is set to Local.

System_CAPS_pubpropertyNamingContainer

(Inherited from Control.)

System_CAPS_pubpropertyPage

(Inherited from Control.)

System_CAPS_pubpropertyPageCountMode

Gets or sets a PageCountMode enumeration value that indicates the default page count mode to use when rendering a report in the report area.

System_CAPS_pubpropertyParent

(Inherited from Control.)

System_CAPS_pubpropertyProcessingMode

Gets or sets the processing mode of the ReportViewer control.

System_CAPS_pubpropertyPromptAreaCollapsed

Gets or sets the collapsed state of the parameter prompt area or the credentials prompt area.

System_CAPS_pubpropertyReportAreaContentType

Gets a ReportAreaContent object that indicates the current content type of the report area.

System_CAPS_pubpropertySearchState

Gets the search text and the start page of the current report search operation.

System_CAPS_pubpropertyServerReport

Gets the instance of the Report class that is used when the ProcessingMode for the ReportViewer control is set to Remote.

System_CAPS_pubpropertyShowBackButton

Gets or sets a value that indicates whether the Back button is visible on the toolbar.

System_CAPS_pubpropertyShowCredentialPrompts

Gets or sets a value that indicates whether to display a prompt for user credentials.

System_CAPS_pubpropertyShowDocumentMapButton

Gets or sets a value that indicates whether the button that shows and collapses the document map is visible on the split bar.

System_CAPS_pubpropertyShowExportControls

Gets or sets a value that indicates whether the Export control is visible on the toolbar.

System_CAPS_pubpropertyShowFindControls

Gets or sets a value that indicates whether the Find text box is visible on the toolbar.

System_CAPS_pubpropertyShowPageNavigationControls

Gets or sets a value that indicates whether the page navigation controls are visible on the toolbar.

System_CAPS_pubpropertyShowParameterPrompts

Gets or sets a value that indicates whether parameter prompts are displayed.

System_CAPS_pubpropertyShowPrintButton

Gets or sets a value that indicates whether Print button is visible on the toolbar.

System_CAPS_pubpropertyShowPromptAreaButton

Gets or sets a value that indicates whether the button that shows and collapses the prompt area is visible on the split bar.

System_CAPS_pubpropertyShowRefreshButton

Gets or sets a value that indicates whether the Refresh button is visible.

System_CAPS_pubpropertyShowReportBody

Gets or sets a value that indicates whether the report body is visible on the control.

System_CAPS_pubpropertyShowToolBar

Gets or sets a value that indicates whether the toolbar is visible on the control.

System_CAPS_pubpropertyShowWaitControlCancelLink

Gets or sets a Boolean value that controls whether to display the Cancel link in the wait control.

System_CAPS_pubpropertyShowZoomControl

Gets or sets a value that indicates whether the Zoom list box is visible.

System_CAPS_pubpropertySite

(Inherited from Control.)

System_CAPS_pubpropertySizeToReportContent

Gets or sets a value that indicates whether the ReportViewer control should automatically resize to accommodate report content.

System_CAPS_pubpropertySkinID

(Inherited from WebControl.)

System_CAPS_pubpropertySplitterBackColor

Gets or sets the background color of the document map split bar and the prompt area split bar.

System_CAPS_pubpropertyStyle

(Inherited from WebControl.)

System_CAPS_pubpropertyTabIndex

(Inherited from WebControl.)

System_CAPS_protpropertyTagKey

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the HtmlTextWriterTag value that corresponds to the ReportViewer control.(Overrides WebControl.TagKey.)

System_CAPS_protpropertyTagName

(Inherited from WebControl.)

System_CAPS_pubpropertyTemplateControl

(Inherited from Control.)

System_CAPS_pubpropertyTemplateSourceDirectory

(Inherited from Control.)

System_CAPS_pubpropertyToolBarItemBorderColor

Gets or sets the border color of an item on the toolbar.

System_CAPS_pubpropertyToolBarItemBorderStyle

Gets or sets the border style of an item on the toolbar.

System_CAPS_pubpropertyToolBarItemBorderWidth

Gets or sets the width of the toolbar item border.

System_CAPS_pubpropertyToolBarItemHoverBackColor

Gets or sets the background color of toolbar item while the mouse pointer is over the item.

System_CAPS_pubpropertyToolBarItemPressedBorderColor

Obsolete.This property is no longer applicable and exists for backward compatibility. ReportViewer control no longer uses pressed buttons.

System_CAPS_pubpropertyToolBarItemPressedBorderStyle

Obsolete.This property is no longer applicable and exists for backward compatibility. The ReportViewer control no longer uses pressed buttons.

System_CAPS_pubpropertyToolBarItemPressedBorderWidth

Obsolete.This property is no longer applicable and exists for backward compatibility. The ReportViewer control no longer uses pressed buttons.

System_CAPS_pubpropertyToolBarItemPressedHoverBackColor

Obsolete.This property is no longer applicable and exists for backward compatibility. The ReportViewer control no longer uses pressed buttons.

System_CAPS_pubpropertyToolTip

(Inherited from WebControl.)

System_CAPS_pubpropertyUniqueID

(Inherited from Control.)

System_CAPS_protpropertyViewState

(Inherited from Control.)

System_CAPS_protpropertyViewStateIgnoresCase

(Inherited from Control.)

System_CAPS_pubpropertyVisible

(Inherited from Control.)

System_CAPS_pubpropertyWaitControlDisplayAfter

Gets or sets the delay in milliseconds before the wait control is displayed to the user when the report is loaded.

System_CAPS_pubpropertyWaitMessageFont

Gets the font for the message that is displayed while the report is being executed.

System_CAPS_pubpropertyWidth

Gets or sets the width of the control.(Overrides WebControl.Width.)

System_CAPS_pubpropertyZoomMode

Gets or sets the zoom mode of the control.

System_CAPS_pubpropertyZoomPercent

Gets or sets the zoom percentage to use when displaying the report.

NameDescription
System_CAPS_protmethodAddAttributesToRender(HtmlTextWriter)

(Inherited from WebControl.)

System_CAPS_protmethodAddedControl(Control, Int32)

(Inherited from Control.)

System_CAPS_protmethodAddParsedSubObject(Object)

(Inherited from Control.)

System_CAPS_pubmethodApplyStyle(Style)

(Inherited from WebControl.)

System_CAPS_pubmethodApplyStyleSheetSkin(Page)

(Inherited from Control.)

System_CAPS_protmethodBuildProfileTree(String, Boolean)

(Inherited from Control.)

System_CAPS_protmethodClearChildControlState()

(Inherited from Control.)

System_CAPS_protmethodClearChildState()

(Inherited from Control.)

System_CAPS_protmethodClearChildViewState()

(Inherited from Control.)

System_CAPS_pubmethodCopyBaseAttributes(WebControl)

(Inherited from WebControl.)

System_CAPS_protmethodCreateChildControls()

This API supports the product infrastructure and is not intended to be used directly from your code. Called by the ASP.NET page framework to notify the ReportViewer control to create any child controls it contain in preparation for posting back or rendering.(Overrides Control.CreateChildControls().)

System_CAPS_protmethodCreateControlCollection()

(Inherited from Control.)

System_CAPS_protmethodCreateControlStyle()

This API supports the product infrastructure and is not intended to be used directly from your code. Creates the style object that is used internally by the control to implement all style related properties.(Overrides WebControl.CreateControlStyle().)

System_CAPS_pubmethodDataBind()

(Inherited from CompositeControl.)

System_CAPS_protmethodDataBind(Boolean)

(Inherited from Control.)

System_CAPS_protmethodDataBindChildren()

(Inherited from Control.)

System_CAPS_pubmethodDispose()

This API supports the product infrastructure and is not intended to be used directly from your code. Releases all the resources used by the ReportViewer class.(Overrides Control.Dispose().)

System_CAPS_protmethodEnsureChildControls()

(Inherited from Control.)

System_CAPS_protmethodEnsureID()

(Inherited from Control.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodFind(String, Int32)

Searches the report in the report area for the specified text string, starting from the specified page number.

System_CAPS_pubmethodFindControl(String)

(Inherited from Control.)

System_CAPS_protmethodFindControl(String, Int32)

(Inherited from Control.)

System_CAPS_pubmethodFocus()

(Inherited from Control.)

System_CAPS_protmethodGetDesignModeState()

(Inherited from Control.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetPageSettings()

Returns the page settings that are used to print the current report in the ReportViewer control.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodHasControls()

(Inherited from Control.)

System_CAPS_protmethodHasEvents()

(Inherited from Control.)

System_CAPS_protmethodIsLiteralContent()

(Inherited from Control.)

System_CAPS_pubmethodJumpToBookmark(String)

Moves the focus of the report to the specified bookmark.

System_CAPS_pubmethodJumpToDocumentMapId(String)

Moves the focus of the document map to the specified node.

System_CAPS_protmethodLoadControlState(Object)

(Inherited from Control.)

System_CAPS_protmethodLoadViewState(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Restores view-state information from a previous request that was saved with the SaveViewState method. (Overrides WebControl.LoadViewState(Object).)

System_CAPS_protmethodMapPathSecure(String)

(Inherited from Control.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodMergeStyle(Style)

(Inherited from WebControl.)

System_CAPS_protmethodOnBubbleEvent(Object, EventArgs)

(Inherited from Control.)

System_CAPS_protmethodOnDataBinding(EventArgs)

(Inherited from Control.)

System_CAPS_protmethodOnInit(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the Init event.(Overrides Control.OnInit(EventArgs).)

System_CAPS_protmethodOnLoad(EventArgs)

(Inherited from Control.)

System_CAPS_protmethodOnPreRender(EventArgs)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises the PreRender event.(Overrides Control.OnPreRender(EventArgs).)

System_CAPS_protmethodOnUnload(EventArgs)

(Inherited from Control.)

System_CAPS_protmethodOpenFile(String)

(Inherited from Control.)

System_CAPS_pubmethodPerformBack()

Navigates the ReportViewer control back to the parent report from a drillthrough report.

System_CAPS_protmethodRaiseBubbleEvent(Object, EventArgs)

(Inherited from Control.)

System_CAPS_protmethodRecreateChildControls()

(Inherited from CompositeControl.)

System_CAPS_pubmethodRegisterPostBackControl(Control)

Registers the specified control with the ReportViewer control. The ReportViewer control displays the wait control when the registered control causes a postback.

System_CAPS_protmethodRemovedControl(Control)

(Inherited from Control.)

System_CAPS_protmethodRender(HtmlTextWriter)

This API supports the product infrastructure and is not intended to be used directly from your code. Renders the control to the specified HTML writer.(Overrides CompositeControl.Render(HtmlTextWriter).)

System_CAPS_pubmethodRenderBeginTag(HtmlTextWriter)

(Inherited from WebControl.)

System_CAPS_protmethodRenderChildren(HtmlTextWriter)

(Inherited from Control.)

System_CAPS_protmethodRenderContents(HtmlTextWriter)

(Inherited from WebControl.)

System_CAPS_pubmethodRenderControl(HtmlTextWriter)

(Inherited from Control.)

System_CAPS_protmethodRenderControl(HtmlTextWriter, ControlAdapter)

(Inherited from Control.)

System_CAPS_pubmethodRenderEndTag(HtmlTextWriter)

(Inherited from WebControl.)

System_CAPS_pubmethodReset()

Resets the control to its default values.

System_CAPS_pubmethodResetPageSettings()

Reverts the page settings for the current report in the ReportViewer control to the settings in the report definition.

System_CAPS_protmethodResolveAdapter()

(Inherited from Control.)

System_CAPS_pubmethodResolveClientUrl(String)

(Inherited from Control.)

System_CAPS_pubmethodResolveUrl(String)

(Inherited from Control.)

System_CAPS_protmethodSaveControlState()

(Inherited from Control.)

System_CAPS_protmethodSaveViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Saves the view state information of the ReportViewer control.(Overrides WebControl.SaveViewState().)

System_CAPS_protmethodSetDesignModeState(IDictionary)

(Inherited from Control.)

System_CAPS_pubmethodSetPageSettings(PageSettings)

Sets the page settings that are used to print the current report in the ReportViewer control.

System_CAPS_pubmethodSetRenderMethodDelegate(RenderMethod)

(Inherited from Control.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_protmethodTrackViewState()

(Inherited from WebControl.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticMaximumPageCount

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

NameDescription
System_CAPS_pubeventBack

Occurs when a user navigates from a drillthrough report back to the parent report.

System_CAPS_pubeventBookmarkNavigation

Occurs when a user browses to a bookmark in a report.

System_CAPS_pubeventDataBinding

(Inherited from Control.)

System_CAPS_pubeventDisposed

(Inherited from Control.)

System_CAPS_pubeventDocumentMapNavigation

Occurs when a document map node is selected.

System_CAPS_pubeventDrillthrough

Occurs when a drillthrough item is selected.

System_CAPS_pubeventInit

(Inherited from Control.)

System_CAPS_pubeventLoad

(Inherited from Control.)

System_CAPS_pubeventPageNavigation

Occurs when a user moves to a different page in a report.

System_CAPS_pubeventPreRender

(Inherited from Control.)

System_CAPS_pubeventReportError

Occurs when an error is found in the report.

System_CAPS_pubeventReportRefresh

Occurs when the report is refreshed.

System_CAPS_pubeventSearch

Occurs when the Find or Find Next button is clicked, or when a search operation is invoked programmatically.

System_CAPS_pubeventSort

Occurs when the user activates a sort on the report data.

System_CAPS_pubeventSubmittingDataSourceCredentials

Occurs when the user submits new data source credentials using the data source prompt area.

System_CAPS_pubeventSubmittingParameterValues

Occurs when report parameter values are submitted to the report server.

System_CAPS_pubeventToggle

Occurs when the user toggles the visibility of an item in the report.

System_CAPS_pubeventUnload

(Inherited from Control.)

This control shows the report and its associated user interface.

The control can work in either local or remote processing mode. In local processing mode, the control processes and renders the report locally. In remote processing mode, processing is done on a report server and displayed locally. The remote processing mode requires a Microsoft SQL Server 2008 or later instance of report server.

System_CAPS_noteNote

For more information about using the ReportViewer Web server control in a Web farm or without session state, see Web.config Settings for ReportViewer.

For information on using the client-side ReportViewer control using the client-side API, see ReportViewer Class.

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

Return to top
Show: