We recommend using Visual Studio 2017

ReportViewerWebPart Class

Represents the Report Viewer Web Part.


Namespace:  Microsoft.ReportingServices.SharePoint.UI.WebParts
Assembly:  Microsoft.ReportingServices.SharePoint.UI.WebParts (in Microsoft.ReportingServices.SharePoint.UI.WebParts.dll)

public class ReportViewerWebPart : WebPart, 

The ReportViewerWebPart type exposes the following members.

Public methodReportViewerWebPartInitializes a new instance of the ReportViewerWebPart class.

Public propertyAccessKey (Inherited from WebControl.)
Protected propertyAdapter (Inherited from Control.)
Public propertyAllowClose (Inherited from WebPart.)
Public propertyAllowConnect (Inherited from WebPart.)
Public propertyAllowEdit (Inherited from WebPart.)
Public propertyAllowHide (Inherited from WebPart.)
Public propertyAllowMinimize (Inherited from WebPart.)
Public propertyAllowRemove Obsolete. (Inherited from WebPart.)
Public propertyAllowZoneChange (Inherited from WebPart.)
Public propertyAppRelativeTemplateSourceDirectory (Inherited from Control.)
Public propertyAsyncRenderingGets 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 loaded.
Public propertyAttributes (Inherited from WebControl.)
Public propertyAuthorizationFilter (Inherited from WebPart.)
Public propertyAutoGenerateDetailLinkGets or sets a Boolean value that indicates whether to generate a hyperlink that appears above the Web Part. You can click the link to open the report in a new page, in full-page mode.
Public propertyAutoGenerateTitleGets or sets a Boolean value that indicates whether the Web part title should be automatically generated from the report that is displayed.
Public propertyBackColor (Inherited from WebControl.)
Public propertyBackImageUrl (Inherited from Panel.)
Public propertyBindingContainer (Inherited from Control.)
Public propertyBorderColor (Inherited from WebControl.)
Public propertyBorderStyle (Inherited from WebControl.)
Public propertyBorderWidth (Inherited from WebControl.)
Public propertyBrowserDesignMode Obsolete. (Inherited from WebPart.)
Protected propertyCacheType (Inherited from WebPart.)
Public propertyCaption Obsolete. (Inherited from WebPart.)
Public propertyCatalogIconImageUrl (Inherited from WebPart.)
Protected propertyChildControlsCreated (Inherited from Control.)
Public propertyChromeState (Inherited from WebPart.)
Public propertyChromeType (Inherited from WebPart.)
Protected propertyClassResourcePath (Inherited from WebPart.)
Public propertyClientID (Inherited from Control.)
Protected propertyClientIDSeparator (Inherited from Control.)
Public propertyClientName (Inherited from WebPart.)
Public propertyConnectErrorMessage (Inherited from WebPart.)
Public propertyConnectionID (Inherited from WebPart.)
Public propertyConnections (Inherited from WebPart.)
Protected propertyContainerWidth Obsolete. (Inherited from WebPart.)
Protected propertyContext (Inherited from Control.)
Public propertyControls (Inherited from Part.)
Public propertyControlStyle (Inherited from WebControl.)
Public propertyControlStyleCreated (Inherited from WebControl.)
Public propertyCssClass (Inherited from WebControl.)
Public propertyCssStyleSheet (Inherited from WebPart.)
Public propertyDefaultButton (Inherited from Panel.)
Public propertyDescription (Inherited from WebPart.)
Protected propertyDesignMode (Inherited from Control.)
Public propertyDetailLink Obsolete. (Inherited from WebPart.)
Public propertyDir Obsolete. (Inherited from WebPart.)
Public propertyDirection (Inherited from WebPart.)
Public propertyDisplayTitle (Inherited from WebPart.)
Public propertyDockToolBarGets or sets the docking location of the toolbar.
Public propertyDocumentMapAreaWidthGets or sets a string that indicates the width of the document map area.
Public propertyDocumentMapModeGets or sets an enumeration value that indicates the visibility mode of the document map area.
Public propertyEffectiveFrameType Obsolete. (Inherited from WebPart.)
Public propertyEffectiveStorage (Inherited from WebPart.)
Public propertyEffectiveTitle (Inherited from WebPart.)
Public propertyEnabled (Inherited from WebControl.)
Public propertyEnableTheming (Inherited from WebControl.)
Public propertyEnableViewState (Inherited from Control.)
Protected propertyEvents (Inherited from Control.)
Public propertyExportControlledProperties Obsolete. (Inherited from WebPart.)
Public propertyExportMode (Inherited from WebPart.)
Public propertyFont (Inherited from WebControl.)
Public propertyForeColor (Inherited from WebControl.)
Public propertyFrameState Obsolete. (Inherited from WebPart.)
Public propertyFrameType Obsolete. (Inherited from WebPart.)
Public propertyGroupingText (Inherited from Panel.)
Public propertyHasAttributes (Inherited from WebControl.)
Protected propertyHasChildViewState (Inherited from Control.)
Public propertyHasSharedData (Inherited from WebPart.)
Public propertyHasUserData (Inherited from WebPart.)
Public propertyHeight (Inherited from WebPart.)
Public propertyHelpLink Obsolete. (Inherited from WebPart.)
Public propertyHelpMode (Inherited from WebPart.)
Public propertyHelpUrl (Inherited from WebPart.)
Public propertyHidden (Inherited from WebPart.)
Public propertyHorizontalAlign (Inherited from Panel.)
Public propertyHyperlinkTargetGets or sets the target frame for displaying linked content within the current report.
Public propertyID (Inherited from WebPart.)
Protected propertyIdSeparator (Inherited from Control.)
Public propertyImportErrorMessage (Inherited from WebPart.)
Protected propertyIsChildControlStateCleared (Inherited from Control.)
Public propertyIsClosed (Inherited from WebPart.)
Protected propertyIsEnabled (Inherited from WebControl.)
Public propertyIsIncluded Obsolete. (Inherited from WebPart.)
Public propertyIsIncludedFilter Obsolete. (Inherited from WebPart.)
Public propertyIsShared (Inherited from WebPart.)
Public propertyIsStandalone (Inherited from WebPart.)
Public propertyIsStatic (Inherited from WebPart.)
Protected propertyIsTrackingViewState (Inherited from Control.)
Protected propertyIsViewStateEnabled (Inherited from Control.)
Public propertyIsVisible Obsolete. (Inherited from WebPart.)
Public propertyKeepSessionAliveGets or sets a Boolean value that indicates whether the ReportViewerWebPart should keep the user session from expiring.
Protected propertyLoadViewStateByID (Inherited from Control.)
Public propertyMissingAssembly Obsolete. (Inherited from WebPart.)
Public propertyNamingContainer (Inherited from Control.)
Protected propertyOverflowAuto (Inherited from WebPart.)
Public propertyOverrideParametersGets a collection of ReportParameter objects that are used to override the default parameters for the report that is being loaded in the Web Part.
Public propertyPage (Inherited from Control.)
Public propertyParent (Inherited from Control.)
Public propertyPartImageLarge Obsolete. (Inherited from WebPart.)
Public propertyPartImageSmall Obsolete. (Inherited from WebPart.)
Public propertyPartOrder Obsolete. (Inherited from WebPart.)
Public propertyPermissions Obsolete. (Inherited from WebPart.)
Public propertyPromptAreaModeGets or sets a value that indicates the visibility mode of the parameter prompt area and the credential prompt area (if applicable).
Public propertyQualifier (Inherited from WebPart.)
Public propertyReportPathGets or sets a fully qualified path to a report that is on the current SharePoint site, or on a site within the same Web application or farm.
Protected propertySaveProperties (Inherited from WebPart.)
Public propertyScrollBars (Inherited from Panel.)
Protected propertySerializeAll (Inherited from WebPart.)
Public propertySerializedAttachedPropertiesShared (Inherited from WebPart.)
Public propertySerializedAttachedPropertiesUser (Inherited from WebPart.)
Protected propertyServerRelativeClassResourcePath (Inherited from WebPart.)
Protected propertyShouldValidate (Inherited from WebPart.)
Public propertySite (Inherited from Control.)
Public propertySkinID (Inherited from WebControl.)
Public propertyStorageKey (Inherited from WebPart.)
Public propertyStyle (Inherited from WebControl.)
Public propertySubtitle (Inherited from WebPart.)
Public propertySuppressWebPartChrome (Inherited from WebPart.)
Public propertyTabIndex (Inherited from WebControl.)
Protected propertyTagKey (Inherited from WebControl.)
Protected propertyTagName (Inherited from WebControl.)
Public propertyTemplateControl (Inherited from Control.)
Public propertyTemplateSourceDirectory (Inherited from Control.)
Public propertyTitleGets or sets the title string of the ReportViewerWebPart. (Overrides WebPartTitle().)
Public propertyTitleIconImageUrl (Inherited from WebPart.)
Public propertyTitleUrl (Inherited from WebPart.)
Public propertyToolBarItemsDisplayModeGets or sets a bit flags enumeration value that specifies which toolbar items are displayed when ToolBarMode is set to Full.
Public propertyToolBarModeGets or sets the display mode of the toolbar.
Public propertyToolTip (Inherited from WebControl.)
Public propertyUniqueID (Inherited from Control.)
Public propertyUnknownXmlElements (Inherited from WebPart.)
Public propertyUseDefaultStyles (Inherited from WebPart.)
Public propertyVerbs (Inherited from WebPart.)
Protected propertyViewState (Inherited from Control.)
Protected propertyViewStateIgnoresCase (Inherited from Control.)
Public propertyVisible (Inherited from Control.)
Public propertyWebBrowsableObject (Inherited from WebPart.)
Protected propertyWebPartManager (Inherited from WebPart.)
Protected propertyWebPartMenu (Inherited from WebPart.)
Public propertyWidth (Inherited from WebPart.)
Protected propertyWorkItemTimeout Obsolete. (Inherited from WebPart.)
Public propertyWrap (Inherited from Panel.)
Public propertyZone (Inherited from WebPart.)
Public propertyZoneID (Inherited from WebPart.)
Public propertyZoneIndex (Inherited from WebPart.)

Protected methodAddAttributesToRender (Inherited from Panel.)
Protected methodAddedControl (Inherited from Control.)
Public methodAddParameterProviderSpecifies the parameter provider Web Part when this Web Part is configured to consume data from that Web Part.
Protected methodAddParsedSubObject (Inherited from WebPart.)
Public methodAfterDeserialize (Inherited from WebPart.)
Public methodApplyStyle (Inherited from WebControl.)
Public methodApplyStyleSheetSkin (Inherited from Control.)
Protected methodBuildProfileTree (Inherited from Control.)
Public methodCanRunAt Obsolete. (Inherited from WebPart.)
Protected methodClearChildControlState (Inherited from Control.)
Protected methodClearChildState (Inherited from Control.)
Protected methodClearChildViewState (Inherited from Control.)
Public methodCopyBaseAttributes (Inherited from WebControl.)
Protected methodCreateChildControlsInfrastructure. Creates the child controls of the ReportViewerWebPart. (Overrides Control.CreateChildControls().)
Protected methodCreateControlCollection (Inherited from Control.)
Protected methodCreateControlStyle (Inherited from Panel.)
Public methodCreateEditorParts (Inherited from WebPart.)
Public methodCreateWebPartMenu (Inherited from WebPart.)
Public methodDataBind() (Inherited from Part.)
Protected methodDataBind(Boolean) (Inherited from Control.)
Protected methodDataBindChildren (Inherited from Control.)
Public methodDispose (Inherited from WebPart.)
Protected methodEnsureChildControls (Inherited from Control.)
Protected methodEnsureID (Inherited from Control.)
Public methodEnsureInterfaces Obsolete. (Inherited from WebPart.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodFindControl(String) (Inherited from Control.)
Protected methodFindControl(String, Int32) (Inherited from Control.)
Public methodFocus (Inherited from Control.)
Protected methodGetCustomBuilder (Inherited from WebPart.)
Public methodGetData Obsolete. (Inherited from WebPart.)
Protected methodGetDesignModeState (Inherited from Control.)
Public methodGetDesignTimeFooter (Inherited from WebPart.)
Public methodGetDesignTimeHeader (Inherited from WebPart.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetInitEventArgs Obsolete. (Inherited from WebPart.)
Public methodGetParametersReturns the parameters of the current report in the ReportViewerWebPart.
Public methodGetRequiresData Obsolete. (Inherited from WebPart.)
Public methodGetToolPartsReturns a list of tool parts that are displayed in the tool pane of the Web-based Web Part design user interface, in the order in which they are displayed. (Overrides WebPartGetToolParts().)
Public methodGetType (Inherited from Object.)
Public methodHasControls (Inherited from Control.)
Protected methodHasEvents (Inherited from Control.)
Protected methodIsLiteralContent (Inherited from Control.)
Protected methodLoadControlState (Inherited from Control.)
Public methodLoadResource (Inherited from WebPart.)
Protected methodLoadViewStateRestores view-state information from a previous request that was saved with the SaveViewState method. (Overrides WebPartLoadViewState(Object).)
Protected methodMapPathSecure (Inherited from Control.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMergeStyle (Inherited from WebControl.)
Protected methodNotifyWorkItemComplete Obsolete. (Inherited from WebPart.)
Protected methodOnBubbleEvent (Inherited from Control.)
Protected methodOnClosing (Inherited from WebPart.)
Protected methodOnConnectModeChanged (Inherited from WebPart.)
Protected methodOnDataBinding (Inherited from WebPart.)
Protected methodOnDeleting (Inherited from WebPart.)
Protected methodOnEditModeChanged (Inherited from WebPart.)
Protected methodOnInitRaises the Init event. (Overrides WebPartOnInit(EventArgs).)
Protected methodOnLoad (Inherited from Control.)
Protected methodOnPreRenderRaises the PreRender event. (Overrides WebPartOnPreRender(EventArgs).)
Protected methodOnUnload (Inherited from WebPart.)
Protected methodOpenFile (Inherited from Control.)
Public methodPartCacheInvalidate() (Inherited from WebPart.)
Protected methodPartCacheInvalidate(Storage) (Inherited from WebPart.)
Protected methodPartCacheInvalidate(Storage, String) (Inherited from WebPart.)
Protected methodPartCacheRead (Inherited from WebPart.)
Protected methodPartCacheWrite (Inherited from WebPart.)
Public methodPartCommunicationConnect Obsolete. (Inherited from WebPart.)
Public methodPartCommunicationInit Obsolete. (Inherited from WebPart.)
Public methodPartCommunicationMain Obsolete. (Inherited from WebPart.)
Protected methodRaiseBubbleEvent (Inherited from Control.)
Protected methodRegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String) Obsolete. (Inherited from WebPart.)
Protected methodRegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean) Obsolete. (Inherited from WebPart.)
Protected methodRegisterWorkItem Obsolete. (Inherited from WebPart.)
Protected methodRegisterWorkItemCallback Obsolete. (Inherited from WebPart.)
Protected methodRemovedControl (Inherited from Control.)
Protected methodRenderInfrastructure. Inherited from T:Microsoft.SharePoint.WebPartPages.WebPart. (Overrides WebPartRender(HtmlTextWriter).)
Public methodRenderBeginTag (Inherited from Panel.)
Protected methodRenderChildrenInfrastructure. Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Overrides Control.RenderChildren(HtmlTextWriter).)
Protected methodRenderContents (Inherited from WebControl.)
Public methodRenderControl(HtmlTextWriter) (Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public methodRenderEndTag (Inherited from Panel.)
Protected methodRenderWebPart (Inherited from WebPart.)
Protected methodRenderWorkItemTimeout Obsolete. (Inherited from WebPart.)
Protected methodReplaceTokens (Inherited from WebPart.)
Protected methodRequiresWebPartClientScript (Inherited from WebPart.)
Protected methodResolveAdapter (Inherited from Control.)
Public methodResolveClientUrl (Inherited from Control.)
Public methodResolveUrl (Inherited from Control.)
Protected methodSaveControlState (Inherited from Control.)
Protected methodSaveViewStateSaves the view-state of the ReportViewerWebPart. (Overrides WebControl.SaveViewState().)
Public methodSetBasePermissionsForSandboxAppDomainSets the base permissions for the sandbox application domain with the supplied permission set. This method is only applicable when ReportPath is set to a report in a SharePoint document library.
Protected methodSetDesignModeState (Inherited from Control.)
Protected methodSetPersonalizationDirty (Inherited from WebPart.)
Public methodSetRenderMethodDelegate (Inherited from Control.)
Public methodSetRowProviderSpecifies the row provider Web Part when this Web Part is configured to consume data from that Web Part.
Protected methodSetWebPartPageComponent (Inherited from WebPart.)
Public methodShouldSerializeAllowConnect (Inherited from WebPart.)
Public methodShouldSerializeAllowEdit (Inherited from WebPart.)
Public methodShouldSerializeAllowHide (Inherited from WebPart.)
Public methodShouldSerializeAllowMinimize (Inherited from WebPart.)
Public methodShouldSerializeAllowRemove (Inherited from WebPart.)
Public methodShouldSerializeAllowZoneChange (Inherited from WebPart.)
Public methodShouldSerializeConnectionID (Inherited from WebPart.)
Public methodShouldSerializeConnections (Inherited from WebPart.)
Public methodShouldSerializeDescription (Inherited from WebPart.)
Public methodShouldSerializeDetailLink (Inherited from WebPart.)
Public methodShouldSerializeDir (Inherited from WebPart.)
Public methodShouldSerializeExportControlledProperties (Inherited from WebPart.)
Public methodShouldSerializeFrameState (Inherited from WebPart.)
Public methodShouldSerializeFrameType (Inherited from WebPart.)
Public methodShouldSerializeHeight (Inherited from WebPart.)
Public methodShouldSerializeHelpLink (Inherited from WebPart.)
Public methodShouldSerializeHelpMode (Inherited from WebPart.)
Public methodShouldSerializeID (Inherited from WebPart.)
Public methodShouldSerializeIsIncluded (Inherited from WebPart.)
Public methodShouldSerializeIsIncludedFilter (Inherited from WebPart.)
Public methodShouldSerializeIsVisible (Inherited from WebPart.)
Public methodShouldSerializeMissingAssembly (Inherited from WebPart.)
Public methodShouldSerializePartImageLarge (Inherited from WebPart.)
Public methodShouldSerializePartImageSmall (Inherited from WebPart.)
Public methodShouldSerializePartOrder (Inherited from WebPart.)
Public methodShouldSerializeTitle (Inherited from WebPart.)
Public methodShouldSerializeWidth (Inherited from WebPart.)
Public methodShouldSerializeZoneID (Inherited from WebPart.)
Public methodToString (Inherited from Object.)
Protected methodTrackViewState (Inherited from WebPart.)

Public eventDataBinding (Inherited from Control.)
Public eventDisposed (Inherited from Control.)
Public eventInit (Inherited from Control.)
Public eventLoad (Inherited from Control.)
Public eventPreRender (Inherited from Control.)
Public eventUnload (Inherited from Control.)

Explicit interface implemetationPrivate methodIScriptControl.GetScriptDescriptors
Explicit interface implemetationPrivate methodIScriptControl.GetScriptReferences
Explicit interface implemetationPrivate methodIParserAccessor.AddParsedSubObject (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlBuilderAccessor.ControlBuilder (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor.DataBindings (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor.Expressions (Inherited from Control.)
Explicit interface implemetationPrivate methodSystem#Web#UI#IAttributeAccessor#GetAttribute (Inherited from WebPart.)
Explicit interface implemetationPrivate methodMicrosoft#SharePoint#WebPartPages#IConnectionData#GetData (Inherited from WebPart.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.GetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate methodMicrosoft#SharePoint#WebPartPages#IConnectionData#GetRequiresData (Inherited from WebPart.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor.HasDataBindings (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor.HasExpressions (Inherited from Control.)
Explicit interface implemetationPrivate methodICompositeControlDesignerAccessor.RecreateChildControls (Inherited from Part.)
Explicit interface implemetationPrivate methodSystem#Web#UI#IAttributeAccessor#SetAttribute (Inherited from WebPart.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.SetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.SetOwnerControl (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlDesignerAccessor.UserData (Inherited from Control.)

You can add the ReportViewerWebPart to a SharePoint application and customize it using its programmatic interface. For example, use the DockToolBar property to programmatically control where the toolbar is displayed. You can control the visibility of individual toolbar items using the ToolBarItemsDisplayMode property.

To supply custom report parameters to the ReportViewerWebPart, use the GetParameters method to see which parameters are available on the report that is currently displayed, then use the OverrideParameters method to supply custom parameter values to the report. To programmatically specify a report path to the ReportViewerWebPart, you can use the ReportPath property.

The ReportViewerWebPart can also consume a report path and report parameters using Web Part connections. Using Web Part connections, an IWebPartRow Web Part can provide a report path to the ReportViewerWebPart, and an IFilterValues Web Part can provide a report parameter to the ReportViewerWebPart.

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