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 that determines whether the user is allowed to split the view. | |
AnnotationDropDownVisible | Gets or Sets the dropdown of annotation toolbar. | |
AnnotationToolbarVisible | Gets or Sets the annotation toolbar's visibility. | |
AutoBackgroundColor | Gets or sets a property to display the background color on the whole area | |
CanExport | Indicates whether the currently loaded report can be exported. | |
CurrentPage | Gets or sets the number of the current document page displayed in the viewer. 1 based. Returns 0 if no report is loaded. Affects History. | |
Document | Gets or sets the Active Reports document to be displayed on the Viewer control. | |
GalleyMode | Gets or sets GalleyMode of report | |
History | Public API for history manipulation. | |
HyperlinkBackColor | Gets or sets the background color of the controls that hosts a hyperlink. The default is transparent. For SectionReports only. | |
HyperlinkForeColor | Gets or sets the color of the text within a control that hosts a hyperlink. The default is Blue. For SectionReports only. | |
HyperlinkUnderline | Gets or sets a value determining whether the text in a control that hosts a hyperlink is underlined. The default value is true. For SectionReports only. | |
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 horizontal pages to display when the viewer is in MultiPageMode. | |
MultiplePageRows | Gets or sets the number of pages displayed vertically when the viewer is in MultiPageMode. | |
OpenedReport | Gets a value indicating the type of report opened | |
PageOffset | Specifies the location of the page in the viewer. | |
PagesBackColor | Public API for background color of report pane. | |
PreviewPages | Pages to load. Pass value less or equal to 0 to load all Applicable only for loading from SectionReport or PageDocument instances | |
PrintingSettings | Gets or sets printing settings | |
RepositionPage | Determines whether the viewer will reposition the view to the top of the page when a user goes to another page after scrolling downward in a page. | |
ScrollbarEnabled |
Public API. Show or hide scrolls within report pane.
| |
ScrollingMode | Gets/sets the scrolling mode | |
SearchResultsBackColor | Gets or sets the background color of the highlighted text when using the Viewer control's Find functionality. | |
SearchResultsForeColor | Gets or sets the color of the highlighted text when using the Viewer control's Find functionality. | |
Sidebar | Gets the sidebar component of the viewer control. | |
SplitView | Gets or sets a value that determines whether the viewer is split into two views. | |
TableOfContents | Gets or sets a reference to the TableOfContentsObject. | |
TargetView | Gets or sets a value that specifies the current target view when SplitView is true. | |
Toolbar | Gets the reference to ToolbarObject of the control. | |
TouchContextMenuStrip | Get or sets the context menu of touch enabled Viewer. | |
TouchMode | Enable touch mode or not. | |
TouchModeButtonVisibility | Display Touch mode button on viewer's toolbar or not. | |
TouchModeToolbar | Pubilc API for touch mode Toolbar manipulation. | |
UITheme | Gets/sets the UI theme | |
UseHyperlinkSettings | Gets or sets whether to apply the hyperlink settings when hyperlinks are displayed in the Viewer. For SectionReports only. | |
ViewType | Gets or sets a value that determines how the viewer shows pages(single/multi/continous). | |
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 report rendering. | |
Export | Overloaded. Exports the specified page range of the currently loaded report to the specified file by using the specified export filter. | |
GetShortcutCommands | Gets the list of viewer shortcuts | |
HandleError | Reports about runtime error | |
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) by using the specified export extension. Note: for page report only. | |
SetParametersValues | Sets values of parameters for the report that is shown. | |
SetShortcutCommandState | Enables or disables the shortcut command | |
ShowFindDialog | Displays Find Dialog |
Name | Description | |
---|---|---|
Action | This event fires when report item with specified action was clicked in the report preview control. | |
ErrorOccured | Fires in case of any error (in error panel etc.). | |
Find | Occurs when the Find dialog finds the requested text in the document. | |
HyperLink | Occurs when the user clicks on text or an image that has a hyperlink assigned to it. | |
LoadCompleted | Occurs after all the viewer pages have been fully loaded. | |
RefreshReport | Fires before report refreshes (right after opening of new report, toggling/sorting and drill-through actions, pressing of buttons: view report (parameters panel), galley mode, refresh, back to parent). In case of no error it fires before 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 has changed in the viewer. |