ActiveReports 15 .NET Edition
GrapeCity.ActiveReports.Viewer.Wpf Assembly / GrapeCity.ActiveReports.Viewer.Wpf Namespace / Viewer Class
Fields 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 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)MultiplePageCols binding property  
    Public Fieldstatic (Shared in Visual Basic)MultiplePageRows binding 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)DesignPrintingSettings binding 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)SourceFormat Dependency Property  
    Public Fieldstatic (Shared in Visual Basic)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)ViewType binding 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 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. 1 based. Returns 0 if no report is loaded. Affects History.  
    Public PropertyGets or sets GalleyMode of report  
    Public PropertyPublic API for history manipulation.  
    Public PropertyGets or sets the background color of the controls that hosts a hyperlink. The default is transparent. For SectionReports only.  
    Public PropertyGets or sets the color of the text within a control that hosts a hyperlink. The default is Blue. For SectionReports only.  
    Public PropertyGets 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 PropertyGets or sets the number of horizontal pages to display when the viewer is in MultiPageMode.  
    Public PropertyGets or sets the number of pages displayed vertically when the viewer is in MultiPageMode.  
    Public PropertyPublic API for background color of report pane.  
    Public PropertyPages to load. Pass value less or equal to 0 to load all Applicable only for loading from SectionReport or PageDocument instances  
    Public PropertyGets or sets printing settings  
    Public PropertyDetermines 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 the background color of the highlighted text when using the Viewer control's Find functionality.  
    Public PropertyGets or sets the color of the highlighted text when using the Viewer control's Find functionality.  
    Public PropertyGets the sidebar component of the viewer control.
     
    Public PropertySpecifies the local/remote report source Uri to display the report in Viewer (i.e. 'http://www.mysite.com/invoice.rpx')  
    Public PropertySpecifies the format of the report source Uri. Should be used when Source does not have an extension.  
    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 true.  
    Public PropertyGets or sets whether to apply the hyperlink settings when hyperlinks are displayed in the Viewer. For SectionReports only.  
    Public PropertyGets or sets a value that determines how the viewer shows pages(single/multi/continous).  
    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 MethodReports about runtime error  
    Public MethodOverloaded. Loads a report.  
    Public MethodOverloaded. Prints the currently opened document(section or page)  
    Public MethodExports the specified loaded report to the specified file (or group of files) by using the specified export extension. Note: for page report only.  
    Public MethodSets values of parameters for the report that is shown.  
    Top
    Public Events
     NameDescription
    Public EventThis event fires when report item with specified action was clicked in the report preview control.  
    Public EventFires in case of any error (in error panel etc.).  
    Public EventOccurs when the user clicks on text or an image that has a hyperlink assigned to it.  
    Public EventOccurs after all the viewer pages have been fully loaded.  
    Public EventFires 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.  
    Top
    See Also