ActiveReports 14
GrapeCity.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 ConstructorInitializes a new instance of Viewer class.  
    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 the dropdown of annotation toolbar.  
    Public PropertyGets or Sets the annotation toolbar's visibility.  
    Public Property

    Indicates whether the currently loaded report can be exported.

     
    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 the Active Reports document to be displayed on the Viewer control.  
    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 mouse mode of the viewer.  
    Public PropertyIndicates whether the "Pan", "Selection Mode" and "Snapshot" buttons are visible in the viewer toolbar.  
    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 PropertySpecifies the location of the page in the viewer.  
    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 Property
    Public 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 PropertyGets or sets a value that determines whether the viewer is split into two views.  
    Public Property

    Gets or sets a reference to the TableOfContentsObject.

     
    Public PropertyGets or sets a value that specifies the current target view when SplitView is true.  
    Public PropertyGets the reference to ToolbarObject of the control.  
    Public PropertyGet or sets the context menu of touch enabled Viewer.
     
    Public PropertyEnable touch mode or not.  
    Public PropertyDisplay Touch mode button on viewer's toolbar or not.  
    Public PropertyPubilc API for touch mode Toolbar manipulation.  
    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 MethodCancels report rendering.  
    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 MethodLoads the specified remote report. Sets values of parameters for the report that is shown.  
    Public MethodDisplays Find Dialog  
    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 Find dialog finds the requested text in the document.  
    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.  
    Public EventOccurs after an item is selected in the table of contents treeview.  
    Public EventOccurs when the user clicks an item in the table of contents treeview.  
    Public EventOccurs when the index of the currently selected item in the table of contents changes.  
    Public EventOccurs when the zoom has changed in the viewer.  
    Top
    See Also