Progress® Telerik® Reporting R1 2020

ReportViewerBase Class

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          System.Windows.FormsContainerControl
            System.Windows.FormsUserControl
              Telerik.ReportViewer.WinFormsReportViewerBase
                Telerik.ReportViewer.WinFormsReportViewer

Namespace:  Telerik.ReportViewer.WinForms
Assembly:  Telerik.ReportViewer.WinForms (in Telerik.ReportViewer.WinForms.dll)

Syntax

C#

VB

Copy

public abstract class ReportViewerBase : UserControl

Public MustInherit Class ReportViewerBase
	Inherits UserControl

The ReportViewerBase type exposes the following members.

Properties

	Name	Description
	AccessibilityKeyMap	Gets or sets the accessibility key shortcuts map, used when the report viewer is in accessible mode. Returns null reference if the viewer's accessibility is not enabled.
	CurrentPage	Gets or sets the current page in the viewer.
	DocumentMapVisible	Gets or sets a value that indicates whether the document map is displayed if any bookmark is defined.
	EnableAccessibility	Gets or sets a value that indicates whether the accessibility features of the report viewer and its contents should be enabled.
	NavigateBackEnabled	Determines if navigate back in report viewer history operation is enabled
	NavigateForwardEnabled	Determines if navigate forward in report viewer history operation is enabled
	ParametersAreaVisible	Gets or sets a value that indicates whether the parameters area is displayed if any parameter editor exists.
	ProcessingState	Gets the current processing state of the viewer
	RenderingExtensions	Gets the available rendering extensions list.
	Report	Obsolete. Gets or sets the report displayed in the viewer.
	ReportEngineConnection
	ReportSource	Gets or sets the ReportSource for the report displayed in the viewer.
	Resources
	SearchMetadataOnDemand	Gets or sets a value that indicates whether the search metadata will be delivered on demand or by default.
	ShowDocumentMapButton	Indicates whether DocumentMap button should be visible.
	ShowExportButton	Indicates whether Export button should be visible.
	ShowHistoryButtons	Indicates whether the history (Back, Forward) buttons should be visible.
	ShowPageNavigationControls	Indicates whether the page navigation controls are visible.
	ShowPageSetup	Obsolete. Indicates whether PageSetup button should be visible.
	ShowPageSetupButton	Indicates whether PageSetup button should be visible.
	ShowParametersButton	Indicates whether Parameters button should be visible.
	ShowPrintButton	Indicates whether Print button should be visible.
	ShowPrintPreviewButton	Indicates whether PrintPreview button should be visible.
	ShowProgress	Indicates whether progress animation should be displayed while the report is rendered.
	ShowRefreshButton	Indicates whether the Refresh button should be visible.
	ShowSearchButton	Indicates whether Search button should be visible.
	ShowStopButton	Indicates whether the Stop button should be visible.
	ShowZoom	Indicates whether the Zoom input box should be visible.
	ToolbarVisible	Indicates whether the toolbar should be visible on the viewer.
	TotalPages	Gets the count of the available pages in the viewer.
	ViewMode	Specifies whether the viewer is in interactive or print preview mode.
	ZoomMode	Gets or sets the zoom mode of the viewer.
	ZoomPercent	Gets or sets the percentage of zoom used for the report display.

Top

Methods

	Name	Description
	AddToRenderingContext
	CancelRendering	Stops the background processing of the report.
	CancelRendering(Int32)	Obsolete. Stops background processing of the report.
	CanMoveToPage	Determines whether the viewer can be navigated to a specified page.
	ClearHistory	Clears the report viewer navigation history.
	Dispose	Releases the unmanaged resources used by the ReportViewerBase and optionally releases the managed resources (Overrides ContainerControlDispose(Boolean).)
	ExportReport	Exports the report in the specified format.
	NavigateBack	Navigates the viewer back one step in the navigation history.
	NavigateForward	Navigates the viewer forward one step in the navigation history.
	OnError	Raises the Error event.
	OnExport	Obsolete. Raises the Export event.
	OnExportBegin	Raises the ExportBegin event.
	OnExportEnd	Raises the ExportEnd event.
	OnInteractiveActionEnter	Raises the InteractiveActionEnter event.
	OnInteractiveActionExecuting	Raises the InteractiveActionExecuting event.
	OnInteractiveActionLeave	Raises the InteractiveActionLeave event.
	OnLoad	(Overrides UserControlOnLoad(EventArgs).)
	OnPrint	Obsolete. Raises the Print event.
	OnPrintBegin(CancelEventArgs)	Obsolete. Raises the Print event.
	OnPrintBegin(PrintBeginEventArgs)	Raises the Print event.
	OnPrintEnd(EventArgs)	Obsolete. Raises the PrintEnd event.
	OnPrintEnd(PrintEndEventArgs)	Raises the PrintEnd event.
	OnRenderingBegin(CancelEventArgs)	Obsolete. Raises the RenderingBegin event.
	OnRenderingBegin(RenderingBeginEventArgs)	Raises the RenderingBegin event.
	OnRenderingEnd(EventArgs)	Obsolete. Raises the RenderingEnd event.
	OnRenderingEnd(RenderingEndEventArgs)	Raises the RenderingEnd event.
	OnToolTipExecuting	Raises the ViewerToolTipOpening event.
	OnUpdateUI	Raises the UpdateUI event.
	Preview	Renders the report in the viewer passing the currently entered parameter values to the report.
	PrintReport	Opens the print dialog for the report
	PrintReportInternal
	ProcessCmdKey	Capture the keystrokes to determine if a valid accessible area shortcut is pressed (Overrides ContainerControlProcessCmdKey(Message, Keys).)
	RefreshData	Obsolete. Loads and refreshes the current report source in the viewer.
	RefreshReport	Loads and refreshes the ReportSource in the viewer.
	Reset	Resets the control to its default values.
	ShowPageSetupDialog	Opens the page setup dialog
	ToggleReportContentSearch	Toggles the search dialog to search within the document. If the search metadata is not prepared, invokes report refresh to generate the search metadata and then opens the dialog.

Top

Events

	Name	Description
	AccessibilityChanged	Occurs when the EnableAccessibility property is changed.
	Error	Occurs when there is an error in the report viewer control.
	Export	Obsolete. Occurs when the report in the viewer control is exported.
	ExportBegin	Occurs when the report in the viewer control starts exporting.
	ExportEnd	Occurs when the report exporting in the viewer control is finished.
	InteractiveActionEnter	Occurs when the mouse cursor enters the area of a report item's action.
	InteractiveActionExecuting	Occurs when an action is being executed. Execution can be canceled.
	InteractiveActionLeave	Occurs when the mouse cursor leaves the area of a report item's action.
	Print	Obsolete. Occurs when the report in the viewer control is printed.
	PrintBegin	Occurs when the report in the viewer control starts printing.
	PrintEnd	Occurs when the report printing in the viewer control is finished.
	RenderingBegin	Occurs when the report in the viewer control starts rendering.
	RenderingEnd	Occurs when the report rendering in the viewer control is finished.
	UpdateUI	Occurs when the UI of the report viewer control is updated.
	ViewerAreaPaint	Occurs when the viewer's area is painted.
	ViewerToolTipOpening	Occurs when the tooltip, associated with a report item, is being opened

Top

Version Information

Supported in: 1.0.1

See Also

Reference

Telerik.ReportViewer.WinForms Namespace