MESCIUS.ActiveReports.Viewer.Wpf Assembly / GrapeCity.ActiveReports.Viewer.Wpf Namespace / Viewer Class
Fields Properties Methods Events

Viewer Class Members

The following tables list the members exposed by Viewer.

Public Constructors
 NameDescription
Public ConstructorInitializes the new instance of Viewer class.
 
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)Gets or sets a value that determines whether the user is allowed to split the view.  
Public Fieldstatic (Shared in Visual Basic)Gets or sets the background color of the controls that hosts a hyperlink. The default is transparent. For SectionReports only.  
Public Fieldstatic (Shared in Visual Basic)Gets or sets the color of the text within a control that hosts a hyperlink. The default is Blue. For SectionReports only.  
Public Fieldstatic (Shared in Visual Basic)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.  
Public Fieldstatic (Shared in Visual Basic)Identifies the MultiplePageCols dependency property.  
Public Fieldstatic (Shared in Visual Basic)Identifies the MultiplePageRows dependency property.  
Public Fieldstatic (Shared in Visual Basic)Public API for background color of report pane.  
Public Fieldstatic (Shared in Visual Basic)Pages to load. Pass value less or equal to 0 to load all Applicable only for loading from SectionReport or PageDocument instances.  
Public Fieldstatic (Shared in Visual Basic)Identifies the DesignPrintingSettings dependency property.  
Public Fieldstatic (Shared in Visual Basic)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.  
Public Fieldstatic (Shared in Visual Basic)Public API. Show or hide scrolls within report pane.  
Public Fieldstatic (Shared in Visual Basic)Gets or sets the background color of the highlighted text when using the Viewer control's Find functionality.  
Public Fieldstatic (Shared in Visual Basic)Gets or sets the color of the highlighted text when using the Viewer control's Find functionality.  
Public Fieldstatic (Shared in Visual Basic)Identifies the SourceFormat dependency property.  
Public Fieldstatic (Shared in Visual Basic)Identifies the Source dependency property.  
Public Fieldstatic (Shared in Visual Basic)Gets or sets a value that determines whether the viewer is split into two views.  
Public Fieldstatic (Shared in Visual Basic)Gets or sets a value that specifies the current target view when SplitView is true.  
Public Fieldstatic (Shared in Visual Basic)Gets or sets whether to apply the hyperlink settings when hyperlinks are displayed in the Viewer. For SectionReports only.  
Public Fieldstatic (Shared in Visual Basic)Identifies the ViewType dependency property.  
Public Fieldstatic (Shared in Visual Basic)Gets or sets the viewer's zoom level. -1 for FitWidth mode -2 for Fit Whole Page mode. Throws ArgumentOutOfRangeException on invalid value.  
Top
Public Properties
 NameDescription
Public PropertyGets or sets a value that determines whether the user is allowed to split the view.  
Public PropertyGets or sets a value indicating whether the viewer should fill the entire view area with the report page background color.  
Public PropertyIndicates whether the loaded report can be exported or not. Returns "false" if export is not permitted.  
Public PropertyGets or sets the number of the current document page displayed in the viewer. The page numbering is 1-based.  
Public PropertyGets the section report document displayed in the viewer.  
Public PropertyGets or sets GalleyMode of report  
Public PropertyGets the history API for manipulating the viewer's history.  
Public PropertyGets or sets a value indicating the hyperlinks background color in the displayed document.  
Public PropertyGets or sets a value indicating the hyperlinks text color in the displayed document.  
Public PropertyGets or sets a value indicating whether the hyperlinks text should be underlined in the displayed document.  
Public PropertyGets or sets a value indicating the number of pages displayed horizontally when the viewer is in MultiPageMode.  
Public PropertyGets or sets a value indicating the number of pages displayed vertically when the viewer is in MultiPageMode.  
Public PropertyGets or sets a value that indicates the background color of the report pane.  
Public PropertyGets or sets the number of pages to load. Pass a value less than or equal to 0 to load all pages.  
Public PropertyGets or sets a value representing the printing settings for the currently displayed report.  
Public PropertyGets or sets a value that 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.  
Public PropertyPublic API. Show or hide scrolls within report pane.  
Public PropertyGets or sets a value indicating the background color of the search result.  
Public PropertyGets or sets a value indicating the text color of the search result.  
Public PropertyGets the sidebar component of the viewer control.
 
Public PropertyGets or sets the local or remote URI of the report to display in the Viewer.  
Public PropertyGets or sets a value indicating the format of the report URI.  
Public PropertyGets or sets a value that determines whether the viewer is split into two views.  
Public PropertyGets the table of contents panel component of sidebar component.
 
Public PropertyGets or sets a value that specifies the current target view when SplitView is enabled.  
Public PropertyGets or sets a value indicating whether to apply the hyperlink settings when hyperlinks are displayed in the Viewer.  
Public PropertyGets or sets a value that determines how the viewer shows pages (single/multi/continuous).  
Public PropertyGets 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 MethodReleases the resources used by Viewer control.
 
Public MethodOverloaded. Exports the specified page range of the currently loaded report to the specified file by using the specified export filter.  
Public MethodHandles runtime error on the viewer.  
Public MethodOverloaded. Loads a report.  
Public MethodOverloaded. Prints the currently opened report.  
Public MethodExports the specified loaded report to the specified file (or group of files) by using the specified rendering extension.  
Public MethodSets the values of the parameters for the currently displayed report.  
Top
Public Events
 NameDescription
Public EventOccurs when an action is performed on the document in the viewer.  
Public EventOccurs when an error occurs within the viewer. This event provides detailed information about the error, allowing for custom error handling or logging.  
Public EventOccurs when a hyperlink is clicked in the currently opened document.  
Public EventOccurs after all the viewer pages have been fully loaded.  
Public EventOccurs before the viewer refreshes the report.  
Top
See Also