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
	ReportViewerWebPart	Initializes a new instance of the ReportViewerWebPart class.

Top

Properties

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

Top

Methods

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

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	IScriptControl.GetScriptDescriptors
	IScriptControl.GetScriptReferences
	IParserAccessor.AddParsedSubObject	(Inherited from Control.)
	IControlBuilderAccessor.ControlBuilder	(Inherited from Control.)
	IDataBindingsAccessor.DataBindings	(Inherited from Control.)
	IExpressionsAccessor.Expressions	(Inherited from Control.)
	System#Web#UI#IAttributeAccessor#GetAttribute	(Inherited from WebPart.)
	Microsoft#SharePoint#WebPartPages#IConnectionData#GetData	(Inherited from WebPart.)
	IControlDesignerAccessor.GetDesignModeState	(Inherited from Control.)
	Microsoft#SharePoint#WebPartPages#IConnectionData#GetRequiresData	(Inherited from WebPart.)
	IDataBindingsAccessor.HasDataBindings	(Inherited from Control.)
	IExpressionsAccessor.HasExpressions	(Inherited from Control.)
	ICompositeControlDesignerAccessor.RecreateChildControls	(Inherited from Part.)
	System#Web#UI#IAttributeAccessor#SetAttribute	(Inherited from WebPart.)
	IControlDesignerAccessor.SetDesignModeState	(Inherited from Control.)
	IControlDesignerAccessor.SetOwnerControl	(Inherited from Control.)
	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.

See Also

Reference

Microsoft.ReportingServices.SharePoint.UI.WebParts Namespace