ActiveReports 19 User Guide
MESCIUS.ActiveReports.Viewer.Win Assembly / GrapeCity.ActiveReports.Viewer.Win Namespace / Viewer Class
Properties Methods Events

In This Topic
Viewer Class Members
In This Topic

The following tables list the members exposed by Viewer.

Public Constructors
 NameDescription
Public ConstructorViewer ConstructorInitializes a new instance of Viewer class.  
Top
Public Properties
 NameDescription
Public PropertyAllowSplitterGets or sets a value indicating whether the viewer allows the view to be split into multiple panes.  
Public PropertyAnnotationDropDownVisibleGets or Sets the dropdown of annotation toolbar.  
Public PropertyAnnotationToolbarVisibleGets or Sets the annotation toolbar's visibility.  
Public PropertyAutoBackgroundColorGets or sets a value indicating whether the background color is automatically applied to the entire viewing area.  
Public PropertyCanExport

Indicates whether the currently loaded report can be exported.

 
Public PropertyCurrentPageGets or sets the current page number displayed in the viewer.  
Public PropertyDocumentGets or sets the Active Reports document to be displayed on the Viewer control.  
Public PropertyGalleyModeGets or sets a value indicating whether the viewer is in Galley Mode.  
Public PropertyHistoryProvides access to the history management functionality of the viewer.  
Public PropertyHyperlinkBackColorGets or sets the background color for hyperlink text areas within the report viewer. This setting applies only to SectionReports.  
Public PropertyHyperlinkForeColorGets or sets the foreground color of hyperlinks displayed within the report viewer.  
Public PropertyHyperlinkUnderlineGets or sets a value indicating whether the hyperlink text within the report viewer is underlined. This property is applicable only to SectionReports.  
Public PropertyMouseModeGets or sets the mouse mode of the viewer.  
Public PropertyMouseModeButtonsVisibleIndicates whether the "Pan", "Selection Mode" and "Snapshot" buttons are visible in the viewer toolbar.  
Public PropertyMultiplePageColsGets or sets the number of pages that are displayed horizontally in the viewer when it is in MultiPage view mode.  
Public PropertyMultiplePageRowsGets or sets the number of pages that are displayed vertically in the viewer when it is in MultiPage view mode.  
Public PropertyOpenedReportGets the type of the report currently opened in the viewer.  
Public PropertyPageOffsetSpecifies the location of the page in the viewer.  
Public PropertyPagesBackColorGets or sets the background color of the pages within the viewer.  
Public PropertyPreviewPagesGets or sets the number of pages to preview when loading a report. Setting this property to a value less than or equal to 0 will result in all pages being loaded and available for preview.  
Public PropertyPrintingSettingsGets or sets the printing settings for the Viewer, determining the behavior of the print operation.  
Public PropertyRepositionPageGets or sets a value indicating whether the viewer repositions the view to the top of the page when a user navigates to another page after scrolling down on the current page.  
Public PropertyScrollbarEnabled
Public API. Show or hide scrolls within report pane.
 
Public PropertyScrollingModeGets or sets the scrolling behavior for the document within the viewer.  
Public PropertySearchResultsBackColorGets or sets the background color used to highlight text found using the search functionality in the Viewer control.  
Public PropertySearchResultsForeColorGets or sets the foreground color used to highlight text found using the search functionality in the Viewer control.  
Public PropertySidebarGets the sidebar component of the viewer control.
 
Public PropertySplitViewGets or sets a value indicating whether the viewer is in Split View mode.  
Public PropertyTableOfContents

Gets or sets a reference to the TableOfContentsObject.

 
Public PropertyTargetViewGets or sets a value indicating the current target view when the SplitView feature is enabled.  
Public PropertyToolbarGets the reference to ToolbarObject of the control.  
Public PropertyTouchContextMenuStripGet or sets the context menu of touch enabled Viewer.
 
Public PropertyTouchModeGets or sets a value indicating whether the touch mode is enabled or disabled in the viewer.  
Public PropertyTouchModeButtonVisibilityGets or sets the visibility of the touch mode button on the viewer's toolbar.  
Public PropertyTouchModeToolbarGets the toolbar used in touch mode.  
Public PropertyUIThemeSpecifies the visual theme for the viewer's user interface.  
Public PropertyUseHyperlinkSettingsGets or sets a value indicating whether the viewer should apply the specified hyperlink settings, such as color, underline, and background color, to hyperlinks within SectionReports.  
Public PropertyViewTypeGets or sets the view type for displaying pages within the viewer.  
Public PropertyZoomGets or sets the viewer's zoom level. 1 for FitWidth mode 2 for Fit Whole Page mode. Throws ArgumentOutOfRangeException on invalid value.  
Top
Public Methods
 NameDescription
Public MethodCancelRenderCancels the current report rendering process.  
Public MethodExportOverloaded. Exports the currently loaded report to the specified file using the given export filter.  
Public MethodGetShortcutCommandsRetrieves a collection of keyboard shortcuts configured for the viewer.  
Public MethodHandleErrorHandles runtime errors by reporting them to the viewer's model for appropriate action.  
Public MethodLoadDocumentOverloaded. Loads a report.  
Public MethodPrintOverloaded. Prints the currently opened document (section or page).  
Public MethodRenderExports the specified loaded report to the specified file (or group of files) using the specified export extension.  
Public MethodSetParametersValuesSets values for the parameters of the currently displayed report in the Viewer.  
Public MethodSetShortcutCommandStateSets the enabled or disabled state of a specified viewer command.  
Public MethodShowFindDialogOpens the Find Dialog to allow users to search for text within the report.  
Top
Public Events
 NameDescription
Public EventActionOccurs when a report item, configured with an interactive action, is clicked within the report preview control.  
Public EventErrorOccuredOccurs when an error occurs within the viewer. This event provides detailed information about the error, allowing for custom error handling or logging.  
Public EventFindOccurs when the Find dialog successfully locates the specified text within the document.  
Public EventHyperLinkOccurs when the user clicks on text or an image that has a hyperlink assigned to it.  
Public EventLoadCompletedOccurs after the document has been fully loaded and rendered in the viewer. public partial class MyForm : Form { private Viewer viewer; public MyForm() { InitializeComponent(); // Initialize the viewer viewer = new Viewer(); this.Controls.Add(viewer); // Subscribe to the LoadCompleted event viewer.LoadCompleted += Viewer_LoadCompleted; } private void Viewer_LoadCompleted(object sender, EventArgs e) { // Handle the LoadCompleted event // For example, update the status bar with the total number of pages statusBarLabel.Text = $"Total Pages: {viewer.Document.Pages.Count}"; } }  
Public EventRefreshReportOccurs before the report refreshes. This event is triggered in several scenarios, including: - Opening a new report. - Performing actions such as toggling, sorting, or executing drill-through actions within the report. - Interacting with the UI to view the report (e.g., using the parameters panel), toggling galley mode, refreshing the report, or navigating back to a parent report in a drill-through scenario. In the absence of any errors, this event precedes the LoadCompleted event.  
Public EventTableOfContentsAfterSelectOccurs after an item is selected in the table of contents treeview.  
Public EventTableOfContentsClickOccurs when the user clicks an item in the table of contents treeview.  
Public EventTableOfContentsSelectedIndexChangedOccurs when the index of the currently selected item in the table of contents changes.  
Public EventZoomChangedOccurs when the zoom level of the viewer changes.  
Top
See Also

Reference

Viewer Class
GrapeCity.ActiveReports.Viewer.Win Namespace