ReportViewer Class
Encapsulates the methods and properties used for the ReportViewer control.
Namespace: Microsoft.Reporting.WinForms
Assembly: Microsoft.ReportViewer.WinForms (in Microsoft.ReportViewer.WinForms.dll)
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Windows.Forms.Control
System.Windows.Forms.ScrollableControl
System.Windows.Forms.ContainerControl
System.Windows.Forms.UserControl
Microsoft.Reporting.WinForms.ReportViewer
Syntax
[DockingAttribute(DockingBehavior.Ask)]
public class ReportViewer : UserControl
[DockingAttribute(DockingBehavior::Ask)]
public ref class ReportViewer : UserControl
[<DockingAttribute(DockingBehavior.Ask)>]
type ReportViewer =
class
inherit UserControl
end
<DockingAttribute(DockingBehavior.Ask)>
Public Class ReportViewer
Inherits UserControl
Constructors
Name | Description | |
---|---|---|
ReportViewer() | Constructs a ReportViewer object. |
Properties
Name | Description | |
---|---|---|
AccessibilityObject | (Inherited from Control.) |
|
AccessibleDefaultActionDescription | (Inherited from Control.) |
|
AccessibleDescription | (Inherited from Control.) |
|
AccessibleName | (Inherited from Control.) |
|
AccessibleRole | (Inherited from Control.) |
|
ActiveControl | (Inherited from ContainerControl.) |
|
AllowDrop | (Inherited from Control.) |
|
Anchor | (Inherited from Control.) |
|
AutoScaleDimensions | (Inherited from ContainerControl.) |
|
AutoScaleFactor | (Inherited from ContainerControl.) |
|
AutoScaleMode | (Inherited from ContainerControl.) |
|
AutoScroll | (Inherited from ScrollableControl.) |
|
AutoScrollMargin | (Inherited from ScrollableControl.) |
|
AutoScrollMinSize | (Inherited from ScrollableControl.) |
|
AutoScrollOffset | (Inherited from Control.) |
|
AutoScrollPosition | (Inherited from ScrollableControl.) |
|
AutoSize | (Inherited from UserControl.) |
|
AutoSizeMode | (Inherited from UserControl.) |
|
AutoValidate | (Inherited from UserControl.) |
|
BackColor | Gets or sets the background color of the control's report area.(Overrides Control.BackColor.) |
|
BackgroundImage | Gets or sets the background image of the ReportViewer control.(Overrides Control.BackgroundImage.) |
|
BackgroundImageLayout | Gets or sets the layout for the background image of the ReportViewer control.(Overrides Control.BackgroundImageLayout.) |
|
BindingContext | (Inherited from ContainerControl.) |
|
BorderStyle | Gets or sets the border style of the ReportViewer control. |
|
Bottom | (Inherited from Control.) |
|
Bounds | (Inherited from Control.) |
|
CanFocus | (Inherited from Control.) |
|
CanRaiseEvents | (Inherited from Control.) |
|
CanSelect | (Inherited from Control.) |
|
Capture | (Inherited from Control.) |
|
CausesValidation | (Inherited from Control.) |
|
ClientRectangle | (Inherited from Control.) |
|
ClientSize | (Inherited from Control.) |
|
CompanyName | (Inherited from Control.) |
|
Container | (Inherited from Component.) |
|
ContainsFocus | (Inherited from Control.) |
|
ContextMenu | (Inherited from Control.) |
|
ContextMenuStrip | (Inherited from Control.) |
|
Controls | (Inherited from Control.) |
|
Created | (Inherited from Control.) |
|
CreateParams | (Inherited from UserControl.) |
|
CurrentAutoScaleDimensions | (Inherited from ContainerControl.) |
|
CurrentPage | Gets or sets the current page of the ReportViewer control's active report. |
|
CurrentStatus | Gets a ReportViewerStatus object that indicates which operations can currently be performed on the ReportViewer control, the status of the prompt area, and the status of the document map area. |
|
Cursor | (Inherited from Control.) |
|
DataBindings | (Inherited from Control.) |
|
DefaultCursor | (Inherited from Control.) |
|
DefaultImeMode | (Inherited from Control.) |
|
DefaultMargin | (Inherited from Control.) |
|
DefaultMaximumSize | (Inherited from Control.) |
|
DefaultMinimumSize | (Inherited from Control.) |
|
DefaultPadding | (Inherited from Control.) |
|
DefaultSize | (Inherited from UserControl.) |
|
DesignMode | (Inherited from Component.) |
|
DisplayMode | Gets a DisplayMode value that indicates the current display mode of the ReportViewer control. |
|
DisplayRectangle | (Inherited from ScrollableControl.) |
|
Disposing | (Inherited from Control.) |
|
Dock | (Inherited from Control.) |
|
DocumentMapCollapsed | Gets or sets the collapsed state of the document map. |
|
DocumentMapWidth | Gets or sets the width of the document map in pixels. |
|
DoubleBuffered | (Inherited from Control.) |
|
Enabled | (Inherited from Control.) |
|
Events | (Inherited from Component.) |
|
Focused | (Inherited from Control.) |
|
Font | (Inherited from Control.) |
|
FontHeight | (Inherited from Control.) |
|
ForeColor | (Inherited from Control.) |
|
Handle | (Inherited from Control.) |
|
HasChildren | (Inherited from Control.) |
|
Height | (Inherited from Control.) |
|
HorizontalScroll | (Inherited from ScrollableControl.) |
|
HScroll | (Inherited from ScrollableControl.) |
|
ImeMode | (Inherited from Control.) |
|
InvokeRequired | (Inherited from Control.) |
|
IsAccessible | (Inherited from Control.) |
|
IsDisposed | (Inherited from Control.) |
|
IsDocumentMapWidthFixed | Indicates whether the size of the document map panel is fixed or changes when the viewer resizes. |
|
IsHandleCreated | (Inherited from Control.) |
|
IsMirrored | (Inherited from Control.) |
|
KeepSessionAlive | Gets or sets a Boolean value that indicates whether to keep the report server session from expiring as long as ReportViewer is running. |
|
LayoutEngine | (Inherited from Control.) |
|
Left | (Inherited from Control.) |
|
LocalReport | Returns the local report in the ReportViewer control. |
|
Location | (Inherited from Control.) |
|
Margin | (Inherited from Control.) |
|
MaximumSize | (Inherited from Control.) |
|
Messages | Gets or sets an object that contains custom messages for use by the ReportViewer control. |
|
MinimumSize | (Inherited from Control.) |
|
Name | (Inherited from Control.) |
|
Padding | (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.) |
|
ParentForm | (Inherited from ContainerControl.) |
|
PreferredSize | (Inherited from Control.) |
|
PrinterSettings | Gets or sets a PrinterSettings object that contains the settings for the default printer and print options that are used to initialize the Print dialog and the printer's Preferences dialog. |
|
ProcessingMode | Gets or sets the processing mode of the ReportViewer control. |
|
ProductName | (Inherited from Control.) |
|
ProductVersion | (Inherited from Control.) |
|
PromptAreaCollapsed | Gets or sets the collapsed state of the parameter prompt area or the credentials prompt area. |
|
RecreatingHandle | (Inherited from Control.) |
|
Region | (Inherited from Control.) |
|
RenderRightToLeft | (Inherited from Control.) |
|
ResizeRedraw | (Inherited from Control.) |
|
Right | (Inherited from Control.) |
|
RightToLeft | (Inherited from Control.) |
|
ScaleChildren | (Inherited from Control.) |
|
SearchState | Gets the search text and the start page of the current report search operation. |
|
ServerReport | Gets a server report in the Report Viewer. |
|
ShowBackButton | Indicates whether the Back button is visible on the control. |
|
ShowContextMenu | Indicates whether the Context menu is visible. |
|
ShowCredentialPrompts | Indicates whether prompts for user credentials will be displayed. |
|
ShowDocumentMapButton | Indicates whether the button that shows and collapses the document map is visible on the split bar. |
|
ShowExportButton | Indicates whether the Export button is visible on the control. |
|
ShowFindControls | Indicates whether the Find text box is visible on the control. |
|
ShowFocusCues | (Inherited from Control.) |
|
ShowKeyboardCues | (Inherited from Control.) |
|
ShowPageNavigationControls | Indicates whether the page navigation controls are visible. |
|
ShowParameterPrompts | Indicates whether parameter prompts are visible. |
|
ShowPrintButton | Gets or sets a value that indicates whether the Print button is visible. |
|
ShowProgress | Indicates whether progress animation is displayed during report processing. |
|
ShowPromptAreaButton | Indicates whether the button that shows and collapses the prompt area is visible on the split bar. |
|
ShowRefreshButton | Indicates whether the Refresh button is visible. |
|
ShowStopButton | Indicates whether the Stop button is visible. |
|
ShowToolBar | Indicates whether the Toolbar is visible. |
|
ShowZoomControl | Indicates whether the Zoom list box is visible. |
|
Site | (Inherited from Control.) |
|
Size | (Inherited from Control.) |
|
TabIndex | (Inherited from Control.) |
|
TabStop | (Inherited from Control.) |
|
Tag | (Inherited from Control.) |
|
Text | (Inherited from Control.) |
|
ToolStripRenderer | Gets or sets the ToolStripRenderer used to customize the look and feel of the ReportViewer control's toolbar as well as the context menu on the report. |
|
Top | (Inherited from Control.) |
|
TopLevelControl | (Inherited from Control.) |
|
UseWaitCursor | (Inherited from Control.) |
|
VerticalScroll | (Inherited from ScrollableControl.) |
|
Visible | (Inherited from Control.) |
|
VScroll | (Inherited from ScrollableControl.) |
|
WaitControlDisplayAfter | Gets or sets the delay in milliseconds before the busy status indicator is displayed to the user. |
|
Width | (Inherited from Control.) |
|
ZoomCalculated | Gets the page zoom that is calculated based on the zoom mode. |
|
ZoomMode | Gets or sets the zoom mode of the control. |
|
ZoomPercent | Gets or sets the percentage of zoom used for the report display. |
Methods
Fields
Name | Description | |
---|---|---|
MaximumPageCount | A constant that represents the maximum number of pages in a report when the current page count mode is Estimate. |
Events
Name | Description | |
---|---|---|
AutoSizeChanged | (Inherited from UserControl.) |
|
AutoValidateChanged | (Inherited from UserControl.) |
|
Back | Occurs when a user navigates back to a parent report from a drillthrough report. |
|
BackColorChanged | (Inherited from Control.) |
|
BackgroundImageChanged | (Inherited from Control.) |
|
BackgroundImageLayoutChanged | (Inherited from Control.) |
|
BindingContextChanged | (Inherited from Control.) |
|
BookmarkNavigation | Occurs when the user navigates to a bookmark in a report. |
|
CausesValidationChanged | (Inherited from Control.) |
|
ChangeUICues | (Inherited from Control.) |
|
Click | (Inherited from Control.) |
|
ClientSizeChanged | (Inherited from Control.) |
|
ContextMenuChanged | (Inherited from Control.) |
|
ContextMenuStripChanged | (Inherited from Control.) |
|
ControlAdded | (Inherited from Control.) |
|
ControlRemoved | (Inherited from Control.) |
|
CursorChanged | (Inherited from Control.) |
|
Disposed | (Inherited from Component.) |
|
DockChanged | (Inherited from Control.) |
|
DocumentMapNavigation | Occurs when a document map node is selected. |
|
DoubleClick | (Inherited from Control.) |
|
DragDrop | (Inherited from Control.) |
|
DragEnter | (Inherited from Control.) |
|
DragLeave | (Inherited from Control.) |
|
DragOver | (Inherited from Control.) |
|
Drillthrough | Occurs when a drillthrough item is selected in a report. |
|
EnabledChanged | (Inherited from Control.) |
|
Enter | (Inherited from Control.) |
|
FontChanged | (Inherited from Control.) |
|
ForeColorChanged | (Inherited from Control.) |
|
GiveFeedback | (Inherited from Control.) |
|
GotFocus | (Inherited from Control.) |
|
HandleCreated | (Inherited from Control.) |
|
HandleDestroyed | (Inherited from Control.) |
|
HelpRequested | (Inherited from Control.) |
|
Hyperlink | Occurs when a user clicks a hyperlink in a report. |
|
ImeModeChanged | (Inherited from Control.) |
|
Invalidated | (Inherited from Control.) |
|
KeyDown | (Inherited from Control.) |
|
KeyPress | (Inherited from Control.) |
|
KeyUp | (Inherited from Control.) |
|
Layout | (Inherited from Control.) |
|
Leave | (Inherited from Control.) |
|
Load | (Inherited from UserControl.) |
|
LocationChanged | (Inherited from Control.) |
|
LostFocus | (Inherited from Control.) |
|
MarginChanged | (Inherited from Control.) |
|
MouseCaptureChanged | (Inherited from Control.) |
|
MouseClick | (Inherited from Control.) |
|
MouseDoubleClick | (Inherited from Control.) |
|
MouseDown | (Inherited from Control.) |
|
MouseEnter | (Inherited from Control.) |
|
MouseHover | (Inherited from Control.) |
|
MouseLeave | (Inherited from Control.) |
|
MouseMove | (Inherited from Control.) |
|
MouseUp | (Inherited from Control.) |
|
MouseWheel | (Inherited from Control.) |
|
Move | (Inherited from Control.) |
|
PaddingChanged | (Inherited from Control.) |
|
PageNavigation | Occurs when a user changes pages in a report. |
|
PageSettingsChanged | Occurs when the margins or the page size for the current report in the ReportViewer control have changed. |
|
Paint | (Inherited from Control.) |
|
ParentChanged | (Inherited from Control.) |
|
PreviewKeyDown | (Inherited from Control.) |
|
Occurs when a user prints the report. |
||
PrintingBegin | Occurs when the user clicks the Print button in the Print dialog box. |
|
QueryAccessibilityHelp | (Inherited from Control.) |
|
QueryContinueDrag | (Inherited from Control.) |
|
RegionChanged | (Inherited from Control.) |
|
RenderingBegin | Occurs when the report in the ReportViewer begins rendering. |
|
RenderingComplete | Occurs when the report finishes rendering. |
|
ReportError | Raised when an error occurs in the report. |
|
ReportExport | Occurs when the user clicks the Export button. |
|
ReportRefresh | Occurs when the report is refreshed. |
|
Resize | (Inherited from Control.) |
|
RightToLeftChanged | (Inherited from Control.) |
|
Scroll | (Inherited from ScrollableControl.) |
|
Search | This event occurs when the user clicks the Find or Find Next button, or when a search operation is invoked programmatically. |
|
SizeChanged | (Inherited from Control.) |
|
Sort | Occurs when the user activates a sort. |
|
StatusChanged | Occurs whenever the user interface state of the ReportViewer control changes. |
|
StyleChanged | (Inherited from Control.) |
|
SubmittingDataSourceCredentials | Occurs when the user submits new data source credentials viaby using the built-in prompt area. |
|
SubmittingParameterValues | Occurs when parameter values are submitted to the report server. |
|
SystemColorsChanged | (Inherited from Control.) |
|
TabIndexChanged | (Inherited from Control.) |
|
TabStopChanged | (Inherited from Control.) |
|
TextChanged | (Inherited from Control.) |
|
Toggle | Occurs when the user toggles the visibility of an item in the report. |
|
Validated | (Inherited from Control.) |
|
Validating | (Inherited from Control.) |
|
ViewButtonClick | Occurs when the user clicks the View button. |
|
VisibleChanged | (Inherited from Control.) |
|
ZoomChange | Occurs when the user changes the zoom level of the ReportViewer control. |
Explicit Interface Implementations
Name | Description | |
---|---|---|
IContainerControl.ActivateControl(Control) | (Inherited from ContainerControl.) |
|
IDropTarget.OnDragDrop(DragEventArgs) | (Inherited from Control.) |
|
IDropTarget.OnDragEnter(DragEventArgs) | (Inherited from Control.) |
|
IDropTarget.OnDragLeave(EventArgs) | (Inherited from Control.) |
|
IDropTarget.OnDragOver(DragEventArgs) | (Inherited from Control.) |
Remarks
This control shows the report and its associated user interface.
The control is able to 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.
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
Microsoft.Reporting.WinForms Namespace
Return to top