ReportViewerWebPart Class

Represents the Report Viewer Web Part.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.Panel
        System.Web.UI.WebControls.WebParts.Part
          System.Web.UI.WebControls.WebParts.WebPart
            WebPart
              Microsoft.ReportingServices.SharePoint.UI.WebParts.ReportViewerWebPart

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

Syntax

'Declaration
Public Class ReportViewerWebPart _
    Inherits WebPart _
    Implements IScriptControl
'Usage
Dim instance As ReportViewerWebPart
public class ReportViewerWebPart : WebPart, 
    IScriptControl
public ref class ReportViewerWebPart : public WebPart, 
    IScriptControl
type ReportViewerWebPart =  
    class
        inherit WebPart
        interface IScriptControl
    end
public class ReportViewerWebPart extends WebPart implements IScriptControl

The ReportViewerWebPart type exposes the following members.

Constructors

  Name Description
Public method ReportViewerWebPart Initializes a new instance of the ReportViewerWebPart class.

Top

Properties

  Name Description
Public property AccessKey (Inherited from WebControl.)
Protected property Adapter (Inherited from Control.)
Public property AllowClose (Inherited from WebPart.)
Public property AllowConnect (Inherited from WebPart.)
Public property AllowEdit (Inherited from WebPart.)
Public property AllowHide (Inherited from WebPart.)
Public property AllowMinimize (Inherited from WebPart.)
Public property AllowRemove Obsolete. (Inherited from WebPart.)
Public property AllowZoneChange (Inherited from WebPart.)
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property 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 loaded.
Public property Attributes (Inherited from WebControl.)
Public property AuthorizationFilter (Inherited from WebPart.)
Public property AutoGenerateDetailLink Gets 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 property AutoGenerateTitle Gets or sets a Boolean value that indicates whether the Web part title should be automatically generated from the report that is displayed.
Public property BackColor (Inherited from WebControl.)
Public property BackImageUrl (Inherited from Panel.)
Public property BindingContainer (Inherited from Control.)
Public property BorderColor (Inherited from WebControl.)
Public property BorderStyle (Inherited from WebControl.)
Public property BorderWidth (Inherited from WebControl.)
Public property BrowserDesignMode Obsolete. (Inherited from WebPart.)
Protected property CacheType (Inherited from WebPart.)
Public property Caption Obsolete. (Inherited from WebPart.)
Public property CatalogIconImageUrl (Inherited from WebPart.)
Protected property ChildControlsCreated (Inherited from Control.)
Public property ChromeState (Inherited from WebPart.)
Public property ChromeType (Inherited from WebPart.)
Protected property ClassResourcePath (Inherited from WebPart.)
Public property ClientID (Inherited from Control.)
Protected property ClientIDSeparator (Inherited from Control.)
Public property ClientName (Inherited from WebPart.)
Public property ConnectErrorMessage (Inherited from WebPart.)
Public property ConnectionID (Inherited from WebPart.)
Public property Connections (Inherited from WebPart.)
Protected property ContainerWidth Obsolete. (Inherited from WebPart.)
Protected property Context (Inherited from Control.)
Public property Controls (Inherited from Part.)
Public property ControlStyle (Inherited from WebControl.)
Public property ControlStyleCreated (Inherited from WebControl.)
Public property CssClass (Inherited from WebControl.)
Public property CssStyleSheet (Inherited from WebPart.)
Public property DefaultButton (Inherited from Panel.)
Public property Description (Inherited from WebPart.)
Protected property DesignMode (Inherited from Control.)
Public property DetailLink Obsolete. (Inherited from WebPart.)
Public property Dir Obsolete. (Inherited from WebPart.)
Public property Direction (Inherited from WebPart.)
Public property DisplayTitle (Inherited from WebPart.)
Public property DockToolBar Gets or sets the docking location of the toolbar.
Public property DocumentMapAreaWidth Gets or sets a string that indicates the width of the document map area.
Public property DocumentMapMode Gets or sets an enumeration value that indicates the visibility mode of the document map area.
Public property EffectiveFrameType Obsolete. (Inherited from WebPart.)
Public property EffectiveStorage (Inherited from WebPart.)
Public property EffectiveTitle (Inherited from WebPart.)
Public property Enabled (Inherited from WebControl.)
Public property EnableTheming (Inherited from WebControl.)
Public property EnableViewState (Inherited from Control.)
Protected property Events (Inherited from Control.)
Public property ExportControlledProperties Obsolete. (Inherited from WebPart.)
Public property ExportMode (Inherited from WebPart.)
Public property Font (Inherited from WebControl.)
Public property ForeColor (Inherited from WebControl.)
Public property FrameState Obsolete. (Inherited from WebPart.)
Public property FrameType Obsolete. (Inherited from WebPart.)
Public property GroupingText (Inherited from Panel.)
Public property HasAttributes (Inherited from WebControl.)
Protected property HasChildViewState (Inherited from Control.)
Public property HasSharedData (Inherited from WebPart.)
Public property HasUserData (Inherited from WebPart.)
Public property Height (Inherited from WebPart.)
Public property HelpLink Obsolete. (Inherited from WebPart.)
Public property HelpMode (Inherited from WebPart.)
Public property HelpUrl (Inherited from WebPart.)
Public property Hidden (Inherited from WebPart.)
Public property HorizontalAlign (Inherited from Panel.)
Public property HyperlinkTarget Gets or sets the target frame for displaying linked content within the current report.
Public property ID (Inherited from WebPart.)
Protected property IdSeparator (Inherited from Control.)
Public property ImportErrorMessage (Inherited from WebPart.)
Protected property IsChildControlStateCleared (Inherited from Control.)
Public property IsClosed (Inherited from WebPart.)
Protected property IsEnabled (Inherited from WebControl.)
Public property IsIncluded Obsolete. (Inherited from WebPart.)
Public property IsIncludedFilter Obsolete. (Inherited from WebPart.)
Public property IsShared (Inherited from WebPart.)
Public property IsStandalone (Inherited from WebPart.)
Public property IsStatic (Inherited from WebPart.)
Protected property IsTrackingViewState (Inherited from Control.)
Protected property IsViewStateEnabled (Inherited from Control.)
Public property IsVisible Obsolete. (Inherited from WebPart.)
Public property KeepSessionAlive Gets or sets a Boolean value that indicates whether the ReportViewerWebPart should keep the user session from expiring.
Protected property LoadViewStateByID (Inherited from Control.)
Public property MissingAssembly Obsolete. (Inherited from WebPart.)
Public property NamingContainer (Inherited from Control.)
Protected property OverflowAuto (Inherited from WebPart.)
Public property OverrideParameters Gets 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 property Page (Inherited from Control.)
Public property Parent (Inherited from Control.)
Public property PartImageLarge Obsolete. (Inherited from WebPart.)
Public property PartImageSmall Obsolete. (Inherited from WebPart.)
Public property PartOrder Obsolete. (Inherited from WebPart.)
Public property Permissions Obsolete. (Inherited from WebPart.)
Public property PromptAreaMode Gets or sets a value that indicates the visibility mode of the parameter prompt area and the credential prompt area (if applicable).
Public property Qualifier (Inherited from WebPart.)
Public property ReportPath Gets 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 property SaveProperties (Inherited from WebPart.)
Public property ScrollBars (Inherited from Panel.)
Protected property SerializeAll (Inherited from WebPart.)
Public property SerializedAttachedPropertiesShared (Inherited from WebPart.)
Public property SerializedAttachedPropertiesUser (Inherited from WebPart.)
Protected property ServerRelativeClassResourcePath (Inherited from WebPart.)
Protected property ShouldValidate (Inherited from WebPart.)
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from WebControl.)
Public property StorageKey (Inherited from WebPart.)
Public property Style (Inherited from WebControl.)
Public property Subtitle (Inherited from WebPart.)
Public property SuppressWebPartChrome (Inherited from WebPart.)
Public property TabIndex (Inherited from WebControl.)
Protected property TagKey (Inherited from WebControl.)
Protected property TagName (Inherited from WebControl.)
Public property TemplateControl (Inherited from Control.)
Public property TemplateSourceDirectory (Inherited from Control.)
Public property Title Gets or sets the title string of the ReportViewerWebPart. (Overrides WebPartTitle().)
Public property TitleIconImageUrl (Inherited from WebPart.)
Public property TitleUrl (Inherited from WebPart.)
Public property ToolBarItemsDisplayMode Gets or sets a bit flags enumeration value that specifies which toolbar items are displayed when ToolBarMode is set to Full.
Public property ToolBarMode Gets or sets the display mode of the toolbar.
Public property ToolTip (Inherited from WebControl.)
Public property UniqueID (Inherited from Control.)
Public property UnknownXmlElements (Inherited from WebPart.)
Public property UseDefaultStyles (Inherited from WebPart.)
Public property Verbs (Inherited from WebPart.)
Protected property ViewState (Inherited from Control.)
Protected property ViewStateIgnoresCase (Inherited from Control.)
Public property Visible (Inherited from Control.)
Public property WebBrowsableObject (Inherited from WebPart.)
Protected property WebPartManager (Inherited from WebPart.)
Protected property WebPartMenu (Inherited from WebPart.)
Public property Width (Inherited from WebPart.)
Protected property WorkItemTimeout Obsolete. (Inherited from WebPart.)
Public property Wrap (Inherited from Panel.)
Public property Zone (Inherited from WebPart.)
Public property ZoneID (Inherited from WebPart.)
Public property ZoneIndex (Inherited from WebPart.)

Top

Methods

  Name Description
Protected method AddAttributesToRender (Inherited from Panel.)
Protected method AddedControl (Inherited from Control.)
Public method AddParameterProvider Specifies the parameter provider Web Part when this Web Part is configured to consume data from that Web Part.
Protected method AddParsedSubObject (Inherited from WebPart.)
Public method AfterDeserialize (Inherited from WebPart.)
Public method ApplyStyle (Inherited from WebControl.)
Public method ApplyStyleSheetSkin (Inherited from Control.)
Protected method BuildProfileTree (Inherited from Control.)
Public method CanRunAt Obsolete. (Inherited from WebPart.)
Protected method ClearChildControlState (Inherited from Control.)
Protected method ClearChildState (Inherited from Control.)
Protected method ClearChildViewState (Inherited from Control.)
Public method CopyBaseAttributes (Inherited from WebControl.)
Protected method CreateChildControls Infrastructure. Creates the child controls of the ReportViewerWebPart. (Overrides Control.CreateChildControls().)
Protected method CreateControlCollection (Inherited from Control.)
Protected method CreateControlStyle (Inherited from Panel.)
Public method CreateEditorParts (Inherited from WebPart.)
Public method CreateWebPartMenu (Inherited from WebPart.)
Public method DataBind() (Inherited from Part.)
Protected method DataBind(Boolean) (Inherited from Control.)
Protected method DataBindChildren (Inherited from Control.)
Public method Dispose (Inherited from WebPart.)
Protected method EnsureChildControls (Inherited from Control.)
Protected method EnsureID (Inherited from Control.)
Public method EnsureInterfaces Obsolete. (Inherited from WebPart.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FindControl(String) (Inherited from Control.)
Protected method FindControl(String, Int32) (Inherited from Control.)
Public method Focus (Inherited from Control.)
Protected method GetCustomBuilder (Inherited from WebPart.)
Public method GetData Obsolete. (Inherited from WebPart.)
Protected method GetDesignModeState (Inherited from Control.)
Public method GetDesignTimeFooter (Inherited from WebPart.)
Public method GetDesignTimeHeader (Inherited from WebPart.)
Public method GetHashCode (Inherited from Object.)
Public method GetInitEventArgs Obsolete. (Inherited from WebPart.)
Public method GetParameters Returns the parameters of the current report in the ReportViewerWebPart.
Public method GetRequiresData Obsolete. (Inherited from WebPart.)
Public method GetToolParts Returns 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 method GetType (Inherited from Object.)
Public method HasControls (Inherited from Control.)
Protected method HasEvents (Inherited from Control.)
Protected method IsLiteralContent (Inherited from Control.)
Protected method LoadControlState (Inherited from Control.)
Public method LoadResource (Inherited from WebPart.)
Protected method LoadViewState Restores view-state information from a previous request that was saved with the SaveViewState method. (Overrides WebPartLoadViewState(Object).)
Protected method MapPathSecure (Inherited from Control.)
Protected method MemberwiseClone (Inherited from Object.)
Public method MergeStyle (Inherited from WebControl.)
Protected method NotifyWorkItemComplete Obsolete. (Inherited from WebPart.)
Protected method OnBubbleEvent (Inherited from Control.)
Protected method OnClosing (Inherited from WebPart.)
Protected method OnConnectModeChanged (Inherited from WebPart.)
Protected method OnDataBinding (Inherited from WebPart.)
Protected method OnDeleting (Inherited from WebPart.)
Protected method OnEditModeChanged (Inherited from WebPart.)
Protected method OnInit Raises the Init event. (Overrides WebPartOnInit(EventArgs).)
Protected method OnLoad (Inherited from Control.)
Protected method OnPreRender Raises the PreRender event. (Overrides WebPartOnPreRender(EventArgs).)
Protected method OnUnload (Inherited from WebPart.)
Protected method OpenFile (Inherited from Control.)
Public method PartCacheInvalidate() (Inherited from WebPart.)
Protected method PartCacheInvalidate(Storage) (Inherited from WebPart.)
Protected method PartCacheInvalidate(Storage, String) (Inherited from WebPart.)
Protected method PartCacheRead (Inherited from WebPart.)
Protected method PartCacheWrite (Inherited from WebPart.)
Public method PartCommunicationConnect Obsolete. (Inherited from WebPart.)
Public method PartCommunicationInit Obsolete. (Inherited from WebPart.)
Public method PartCommunicationMain Obsolete. (Inherited from WebPart.)
Protected method RaiseBubbleEvent (Inherited from Control.)
Protected method RegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String) Obsolete. (Inherited from WebPart.)
Protected method RegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean) Obsolete. (Inherited from WebPart.)
Protected method RegisterWorkItem Obsolete. (Inherited from WebPart.)
Protected method RegisterWorkItemCallback Obsolete. (Inherited from WebPart.)
Protected method RemovedControl (Inherited from Control.)
Protected method Render Infrastructure. Inherited from T:Microsoft.SharePoint.WebPartPages.WebPart. (Overrides WebPartRender(HtmlTextWriter).)
Public method RenderBeginTag (Inherited from Panel.)
Protected method RenderChildren Infrastructure. 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 method RenderContents (Inherited from WebControl.)
Public method RenderControl(HtmlTextWriter) (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public method RenderEndTag (Inherited from Panel.)
Protected method RenderWebPart (Inherited from WebPart.)
Protected method RenderWorkItemTimeout Obsolete. (Inherited from WebPart.)
Protected method ReplaceTokens (Inherited from WebPart.)
Protected method RequiresWebPartClientScript (Inherited from WebPart.)
Protected method ResolveAdapter (Inherited from Control.)
Public method ResolveClientUrl (Inherited from Control.)
Public method ResolveUrl (Inherited from Control.)
Protected method SaveControlState (Inherited from Control.)
Protected method SaveViewState Saves the view-state of the ReportViewerWebPart. (Overrides WebControl.SaveViewState().)
Public method SetBasePermissionsForSandboxAppDomain Sets 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 method SetDesignModeState (Inherited from Control.)
Protected method SetPersonalizationDirty (Inherited from WebPart.)
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method SetRowProvider Specifies the row provider Web Part when this Web Part is configured to consume data from that Web Part.
Protected method SetWebPartPageComponent (Inherited from WebPart.)
Public method ShouldSerializeAllowConnect (Inherited from WebPart.)
Public method ShouldSerializeAllowEdit (Inherited from WebPart.)
Public method ShouldSerializeAllowHide (Inherited from WebPart.)
Public method ShouldSerializeAllowMinimize (Inherited from WebPart.)
Public method ShouldSerializeAllowRemove (Inherited from WebPart.)
Public method ShouldSerializeAllowZoneChange (Inherited from WebPart.)
Public method ShouldSerializeConnectionID (Inherited from WebPart.)
Public method ShouldSerializeConnections (Inherited from WebPart.)
Public method ShouldSerializeDescription (Inherited from WebPart.)
Public method ShouldSerializeDetailLink (Inherited from WebPart.)
Public method ShouldSerializeDir (Inherited from WebPart.)
Public method ShouldSerializeExportControlledProperties (Inherited from WebPart.)
Public method ShouldSerializeFrameState (Inherited from WebPart.)
Public method ShouldSerializeFrameType (Inherited from WebPart.)
Public method ShouldSerializeHeight (Inherited from WebPart.)
Public method ShouldSerializeHelpLink (Inherited from WebPart.)
Public method ShouldSerializeHelpMode (Inherited from WebPart.)
Public method ShouldSerializeID (Inherited from WebPart.)
Public method ShouldSerializeIsIncluded (Inherited from WebPart.)
Public method ShouldSerializeIsIncludedFilter (Inherited from WebPart.)
Public method ShouldSerializeIsVisible (Inherited from WebPart.)
Public method ShouldSerializeMissingAssembly (Inherited from WebPart.)
Public method ShouldSerializePartImageLarge (Inherited from WebPart.)
Public method ShouldSerializePartImageSmall (Inherited from WebPart.)
Public method ShouldSerializePartOrder (Inherited from WebPart.)
Public method ShouldSerializeTitle (Inherited from WebPart.)
Public method ShouldSerializeWidth (Inherited from WebPart.)
Public method ShouldSerializeZoneID (Inherited from WebPart.)
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from WebPart.)

Top

Events

  Name Description
Public event DataBinding (Inherited from Control.)
Public event Disposed (Inherited from Control.)
Public event Init (Inherited from Control.)
Public event Load (Inherited from Control.)
Public event PreRender (Inherited from Control.)
Public event Unload (Inherited from Control.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IScriptControl.GetScriptDescriptors
Explicit interface implemetationPrivate method IScriptControl.GetScriptReferences
Explicit interface implemetationPrivate method IParserAccessor.AddParsedSubObject (Inherited from Control.)
Explicit interface implemetationPrivate property IControlBuilderAccessor.ControlBuilder (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.DataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.Expressions (Inherited from Control.)
Explicit interface implemetationPrivate method System#Web#UI#IAttributeAccessor#GetAttribute (Inherited from WebPart.)
Explicit interface implemetationPrivate method Microsoft#SharePoint#WebPartPages#IConnectionData#GetData (Inherited from WebPart.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.GetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate method Microsoft#SharePoint#WebPartPages#IConnectionData#GetRequiresData (Inherited from WebPart.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.HasDataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.HasExpressions (Inherited from Control.)
Explicit interface implemetationPrivate method ICompositeControlDesignerAccessor.RecreateChildControls (Inherited from Part.)
Explicit interface implemetationPrivate method System#Web#UI#IAttributeAccessor#SetAttribute (Inherited from WebPart.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetOwnerControl (Inherited from Control.)
Explicit interface implemetationPrivate property IControlDesignerAccessor.UserData (Inherited from Control.)

Top

Remarks

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.

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.