Name | Description | |
---|---|---|
![]() | Viewer Constructor | Initializes a new instance of Viewer class. |
The following tables list the members exposed by Viewer.
Name | Description | |
---|---|---|
![]() | Viewer Constructor | Initializes a new instance of Viewer class. |
Name | Description | |
---|---|---|
![]() | AllowSplitter | Gets or sets a value indicating whether the viewer allows the view to be split into multiple panes. |
![]() | AnnotationDropDownVisible | Gets or Sets the dropdown of annotation toolbar. |
![]() | AnnotationToolbarVisible | Gets or Sets the annotation toolbar's visibility. |
![]() | AutoBackgroundColor | Gets or sets a value indicating whether the background color is automatically applied to the entire viewing area. |
![]() | CanExport | Indicates whether the currently loaded report can be exported. |
![]() | CurrentPage | Gets or sets the current page number displayed in the viewer. |
![]() | Document | Gets or sets the Active Reports document to be displayed on the Viewer control. |
![]() | GalleyMode | Gets or sets a value indicating whether the viewer is in Galley Mode. |
![]() | History | Provides access to the history management functionality of the viewer. |
![]() | HyperlinkBackColor | Gets or sets the background color for hyperlink text areas within the report viewer. This setting applies only to SectionReports. |
![]() | HyperlinkForeColor | Gets or sets the foreground color of hyperlinks displayed within the report viewer. |
![]() | HyperlinkUnderline | Gets or sets a value indicating whether the hyperlink text within the report viewer is underlined. This property is applicable only to SectionReports. |
![]() | MouseMode | Gets or sets the mouse mode of the viewer. |
![]() | MouseModeButtonsVisible | Indicates whether the "Pan", "Selection Mode" and "Snapshot" buttons are visible in the viewer toolbar. |
![]() | MultiplePageCols | Gets or sets the number of pages that are displayed horizontally in the viewer when it is in MultiPage view mode. |
![]() | MultiplePageRows | Gets or sets the number of pages that are displayed vertically in the viewer when it is in MultiPage view mode. |
![]() | OpenedReport | Gets the type of the report currently opened in the viewer. |
![]() | PageOffset | Specifies the location of the page in the viewer. |
![]() | PagesBackColor | Gets or sets the background color of the pages within the viewer. |
![]() | PreviewPages | Gets 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. |
![]() | PrintingSettings | Gets or sets the printing settings for the Viewer, determining the behavior of the print operation. |
![]() | RepositionPage | Gets 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. |
![]() | ScrollbarEnabled |
Public API. Show or hide scrolls within report pane.
|
![]() | ScrollingMode | Gets or sets the scrolling behavior for the document within the viewer. |
![]() | SearchResultsBackColor | Gets or sets the background color used to highlight text found using the search functionality in the Viewer control. |
![]() | SearchResultsForeColor | Gets or sets the foreground color used to highlight text found using the search functionality in the Viewer control. |
![]() | Sidebar | Gets the sidebar component of the viewer control. |
![]() | SplitView | Gets or sets a value indicating whether the viewer is in Split View mode. |
![]() | TableOfContents | Gets or sets a reference to the TableOfContentsObject. |
![]() | TargetView | Gets or sets a value indicating the current target view when the SplitView feature is enabled. |
![]() | Toolbar | Gets the reference to ToolbarObject of the control. |
![]() | TouchContextMenuStrip | Get or sets the context menu of touch enabled Viewer. |
![]() | TouchMode | Gets or sets a value indicating whether the touch mode is enabled or disabled in the viewer. |
![]() | TouchModeButtonVisibility | Gets or sets the visibility of the touch mode button on the viewer's toolbar. |
![]() | TouchModeToolbar | Gets the toolbar used in touch mode. |
![]() | UITheme | Specifies the visual theme for the viewer's user interface. |
![]() | UseHyperlinkSettings | Gets 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. |
![]() | ViewType | Gets or sets the view type for displaying pages within the viewer. |
![]() | Zoom | Gets or sets the viewer's zoom level. 1 for FitWidth mode 2 for Fit Whole Page mode. Throws ArgumentOutOfRangeException on invalid value. |
Name | Description | |
---|---|---|
![]() | CancelRender | Cancels the current report rendering process. |
![]() | Export | Overloaded. Exports the currently loaded report to the specified file using the given export filter. |
![]() | GetShortcutCommands | Retrieves a collection of keyboard shortcuts configured for the viewer. |
![]() | HandleError | Handles runtime errors by reporting them to the viewer's model for appropriate action. |
![]() | LoadDocument | Overloaded. Loads a report. |
![]() | Overloaded. Prints the currently opened document (section or page). | |
![]() | Render | Exports the specified loaded report to the specified file (or group of files) using the specified export extension. |
![]() | SetParametersValues | Sets values for the parameters of the currently displayed report in the Viewer. |
![]() | SetShortcutCommandState | Sets the enabled or disabled state of a specified viewer command. |
![]() | ShowFindDialog | Opens the Find Dialog to allow users to search for text within the report. |
Name | Description | |
---|---|---|
![]() | Action | Occurs when a report item, configured with an interactive action, is clicked within the report preview control. |
![]() | ErrorOccured | Occurs when an error occurs within the viewer. This event provides detailed information about the error, allowing for custom error handling or logging. |
![]() | Find | Occurs when the Find dialog successfully locates the specified text within the document. |
![]() | HyperLink | Occurs when the user clicks on text or an image that has a hyperlink assigned to it. |
![]() | LoadCompleted | Occurs 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}"; } } |
![]() | RefreshReport | Occurs 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. |
![]() | TableOfContentsAfterSelect | Occurs after an item is selected in the table of contents treeview. |
![]() | TableOfContentsClick | Occurs when the user clicks an item in the table of contents treeview. |
![]() | TableOfContentsSelectedIndexChanged | Occurs when the index of the currently selected item in the table of contents changes. |
![]() | ZoomChanged | Occurs when the zoom level of the viewer changes. |