The StandardPagesViewer type exposes the following members.

Constructors

  NameDescription
Public methodStandardPagesViewer
Creates a new PagesViewer with a default action handler and interactor factories that take into account the CursorMode of the PagesViewer.

Methods

  NameDescription
Public methodBeginUpdate
Call this method in pairs with EndUpdate. In between these calls, the control is not updated.
(Inherited from DocumentViewer.)
Protected methodDispose
Closes and Disposes the pagesviewer.
(Inherited from PagesViewer.)
Public methodEndUpdate
Call this method in pairs with BeginUpdate. In between these calls, the control is not updated.
(Inherited from DocumentViewer.)
Public methodEnsureVisible
Scroll the given rectangle into view.
(Inherited from DocumentViewer.)
Public methodFindPage
Find the page at a given position.
(Inherited from DocumentViewer.)
Public methodGetIntersecting
Returns a subset of a collection of interactors that overlap with the given rectangle.
(Inherited from DocumentViewer.)
Public methodGetPageToDocumentTransform
Returns a transformation that transforms coordinates from page space to document space. If no document is present, or the specified page is not present, the identity transformation will be returned.
(Inherited from DocumentViewer.)
Public methodGoToDestination
Navigate to the given destination.
(Inherited from DocumentViewer.)
Public methodGoToNextPage
Navigate to the next page.
(Inherited from PagesViewer.)
Public methodGoToPreviousPage
Navigate to the previous page. Also see GoToNextPage.
(Inherited from PagesViewer.)
Protected methodOnAnnotationInteractorCreated
Invoked after a new annotation interactor got created.
(Overrides DocumentViewer..::..OnAnnotationInteractorCreated(InteractorEventArgs).)
Protected methodOnClose
Invoked just before a document gets closed.
(Inherited from PagesViewer.)
Protected methodOnCurrentPageChanged
This override adjust the document layout when the current page changes.
(Overrides PagesViewer..::..OnCurrentPageChanged(EventArgs).)
Protected methodOnDocumentInteractorCreated
Invoked after a new document interactor got created.
(Overrides DocumentViewer..::..OnDocumentInteractorCreated(InteractorEventArgs).)
Protected methodOnDragDrop
Raises the DragDrop event and dispatches the event to the interactor that the mouse is over.
(Inherited from DocumentViewer.)
Protected methodOnDragEnter
Raises the DragEnter event and prepares the document viewer for dragging.
(Inherited from DocumentViewer.)
Protected methodOnDragLeave
Raises the DragLeave event.
(Inherited from DocumentViewer.)
Protected methodOnDragOver
Raises the DragOver event and dispatches the event to the interactor that the mouse is over.
(Inherited from DocumentViewer.)
Protected methodOnFocusChanged
This override put the annotation interactor that gets the focus in the current selection.
(Overrides DocumentViewer..::..OnFocusChanged(EventArgs).)
Protected methodOnGotFocus
Invoked after the DocumentViewer control got the focus.
(Inherited from DocumentViewer.)
Protected methodOnKeyDown
This override will handle page-up and page-down keys if not already done so by the base class. It will increase or decrease the current page depending on the key that was pressed.
(Inherited from PagesViewer.)
Protected methodOnKeyPress
Invoked when the document viewer receives a KeyPress event. This method will first raise the KeyPress event of the DocumentViewer. If the event does not get handled by an event handler (i.e. the Handled property of the event remains false), it will pass it to the interactor that has the focus. If the interactor handles the event, it will prohibit further processing by setting the Handled flag.
(Inherited from DocumentViewer.)
Protected methodOnKeyUp
Invoked when the document viewer receives a KeyUp event. This method will first raise the KeyPress event of the DocumentViewer. If the event does not get handled by an event handler (i.e. the Handled property of the event remains false), it will pass it to the interactor that has the focus. If the interactor handles the event, it will prohibit further processing by setting the Handled flag.
(Inherited from DocumentViewer.)
Public methodOnMissingPage (Overrides DocumentViewer..::..OnMissingPage(ElementEventArgs<(Of <<'(Page>)>>)).)
Protected methodOnMouseDown
Raises the System.Windows.Forms.Control.MouseDown event.
(Inherited from DocumentViewer.)
Protected methodOnMouseMove
Raises the System.Windows.Forms.Control.MouseMove event.
(Inherited from DocumentViewer.)
Protected methodOnMouseUp
Raises the System.Windows.Forms.Control.MouseUp event.
(Inherited from DocumentViewer.)
Protected methodOnMouseWheel
This override implements scrolling through pages.
(Inherited from PagesViewer.)
Protected methodOnOpen
This override updates the zoom factor in accordance with the zoom mode.
(Overrides PagesViewer..::..OnOpen(EventArgs).)
Protected methodOnPageInteractorCreated
Invoked after a page interactor gets created.
(Inherited from DocumentViewer.)
Protected methodOnPaint
Raises the System.Windows.Forms.Paint event.
(Inherited from DocumentViewer.)
Protected methodOnResize
This override updates the zoom factor in accordance with the zoom mode.
(Overrides Control..::..OnResize(EventArgs).)
Protected methodOnVisibleChanged
This override updates the zoom factor in accordance with the zoom mode.
(Overrides Control..::..OnVisibleChanged(EventArgs).)
Protected methodOnVisibleRectangleChanged
This method will be invoked when a different part of the document becomes visible. This override will do the following if this means that another page becoms the current one:
  • Execute the javascript close action for the old current page.
  • Raise the CurrentPageChanged event.
  • Execute the javascript open action for the new current page.
(Inherited from PagesViewer.)
Protected methodOnZoomFactorChanged
This override updates the zoom mode, if necessary.
(Overrides DocumentViewer..::..OnZoomFactorChanged(EventArgs).)
Public methodPrint
Print the document shown in this pages viewer with a print dialog.
(Inherited from PagesViewer.)
Protected methodProcessCmdKey (Inherited from DocumentViewer.)
Public methodRotatePageLeft
Rotate a page to the left.
Public methodRotatePageRight
Rotate a page to the right.
Public methodSelectText
Scrolls into view and selects the text match.
(Inherited from DocumentViewer.)
Public methodZoomIn
Increase the zoom factor to the next higher zoom factor if any. The argument coordinates specify the center of the area to zoom in to.
Public methodZoomOut
Decrease the zoom factor to the next lower zoom factor, if any. The argument coordinates specify the center of the area to zoom out to.
Public methodZoomTo
Zoom to the given center point, using the specified zoom factor.
(Inherited from DocumentViewer.)
Public methodZoomToActualSize
Zoom to the actual size of the PDF page assuming a 72 DPI display.
Public methodZoomToFitPage
Change the zoom factor so that the current entire page fits exactly.
(Inherited from PagesViewer.)
Public methodZoomToRectangle
Zoom to a given rectangle.
(Inherited from DocumentViewer.)
Public methodZoomToWidth
Zoom to make the width of the document fit exactly in the reader window.
(Inherited from DocumentViewer.)

Properties

  NameDescription
Public propertyActionHandler
This ActionHandler is responsible for executing actions that triggered by this viewer.
(Inherited from DocumentViewer.)
Public propertyAnnotationInteractorFactory
The annotation interactor factory. This factory will be used to create annotation interactors when a page becomes visible.
(Inherited from DocumentViewer.)
Public propertyCaretBlinkTime
The blink time of the caret, in milliseconds.
(Inherited from DocumentViewer.)
Public propertyCurrentDestination
Returns the current location as an InternalDestination.
(Inherited from PagesViewer.)
Public propertyCurrentPageIndex
The zero-based index of the current page. By default, the current page is defined as the first page that intersects with the visible rectangle. When setting the CurrentPage, the upper-left corner of the page will be aligned with the upper-left corner of the viewer. The current zoom factor will be used.
(Inherited from PagesViewer.)
Public propertyCursorMode
The cursormode controls how the PagesViewer reacts to mouse events.
Public propertyCursorPosition
The current position of the cursor, with respect to the viewer.
(Inherited from DocumentViewer.)
Public propertyDocument
The PDF document that holds the pages that are displayed by this control.
(Inherited from DocumentViewer.)
Public propertyDocumentInteractor
The document interactor of the document viewer.
(Inherited from DocumentViewer.)
Public propertyDocumentInteractorFactory
The document interactor factory. This factory will be used to create a document interactor when opening a document.
(Inherited from DocumentViewer.)
Public propertyDocumentMargin
The margin in points.
Public propertyDocumentToClientTransform
Returns a transformation that transforms coordinates from document space to client space. If no document is present, the identity transformation will be returned.
(Inherited from DocumentViewer.)
Public propertyEnableAnnotations
Controls whether annotations and form fields respond to user input.
Public propertyFocusAnnotation
The annotation that currently has the input focus. If this property is null, no annotation has the focus (but another interactor may have).
(Inherited from DocumentViewer.)
Public propertyFocusInteractor
The interactor that currently has the input focus. If this property is null, no interactor has the focus.
(Inherited from DocumentViewer.)
Public propertyHideHorizontalScrollbar
Hide the horizontal scrollbar.
(Inherited from DocumentViewer.)
Public propertyHideVerticalScrollbar
Hide the vertical scrollbar.
(Inherited from DocumentViewer.)
Public propertyHighlightAnnotations
If true, all active annotations will be highlighted.
Public propertyHighlightFields
If true, all active fields will be highlighted.
Public propertyHorizontalAlignment
Horizontal alignment of the document rectangle inside the viewer window.
(Inherited from DocumentViewer.)
Public propertyHoverCursor
The cursor that is shown when the mouse hovers over the viewer.
(Inherited from DocumentViewer.)
Public propertyHoverInteractor
The interactor that the mouse is over. If null, the mouse is not hovering over an interactor.
(Inherited from DocumentViewer.)
Public propertyIsPainting
True while the viewer still has painting operations queued (due to progressive drawing for example).
(Inherited from DocumentViewer.)
Public propertyLayoutManager
The layout manager determines the layout of all (page) interactors of the document.
(Inherited from DocumentViewer.)
Public propertyMaxZoom
The maximum zoom factor. The zoom factor will never be greater than this value.
(Inherited from DocumentViewer.)
Public propertyMinZoom
The minimum zoom factor. The zoom factor will never be smaller than this value.
(Inherited from DocumentViewer.)
Public propertyPageInteractorFactory
The page interactor factory. This factory will be used to create a page interactors when they come into view.
(Inherited from DocumentViewer.)
Public propertyPageLayout
The PageLayout mode controls how the current document or pages collection is laid out on the viewer canvas.
Public propertyPageSelection
The selection of pages that is shown. Only pages that exist in the document are shown. If null, all pages are shown.
(Inherited from DocumentViewer.)
Public propertyPageSpacing
The spacing in points.
Public propertyRenderSettings
The render settings of the viewer.
(Inherited from DocumentViewer.)
Public propertySelectedText
The currently selected text.
Public propertySelection
The current collection of selected interactors.
(Inherited from DocumentViewer.)
Public propertyShowOverflowMarker
If true, an overflow marker will be shown if text cannot be displayed entirely in a widget.
Public propertyTextSelectMode
The TextSelectMode controls text selection behavior while CursorMode is SelectText.
Public propertyVerticalAlignment
Vertical alignment of the document rectangle inside the viewer window.
(Inherited from DocumentViewer.)
Public propertyViewerSettings
The viewer settings.
(Inherited from DocumentViewer.)
Public propertyVisibleHeight
The height of the visible rectangle in document space.
(Inherited from DocumentViewer.)
Public propertyVisibleLeft
The horizontal position of the left edge of the visible rectangle in document space.
(Inherited from DocumentViewer.)
Public propertyVisibleTop
The vertical position of the top edge of the visible rectangle in document space.
(Inherited from DocumentViewer.)
Public propertyVisibleWidth
The width of the visible rectangle in document space.
(Inherited from DocumentViewer.)
Public propertyZoomFactor
Get or set the zoom factor. A zoom factor of one means that a point (1/72 inch) corresponds to 1 pixel. In other words, the PDF is displayed at a resolution of 72 DPI.
(Inherited from DocumentViewer.)
Public propertyZoomFactors
An array of zoom factors that are used by ZoomIn and ZoomOut to determine the next factor.
Public propertyZoomMode
The zoom mode of the viewer.

Events

  NameDescription
Public eventAnnotationInteractorCreated
Fired after an interactor has been created for an annotation.
(Inherited from DocumentViewer.)
Public eventCurrentPageChanged
Raised after the CurrentPage has changed.
(Inherited from PagesViewer.)
Public eventCursorModeChanged
Raised when the CursorMode changes. You typically handle this event to update the UI of your application, such as e.g. a tool bar.
Public eventDocumentInteractorCreated
Fired after an interactor has been created for a document.
(Inherited from DocumentViewer.)
Public eventFocusChanged
Raised after the focus has changed.
(Inherited from DocumentViewer.)
Public eventHoverChanged
Raised when the mouse starts hovering over a different interactor.
(Inherited from DocumentViewer.)
Public eventMessage
Raised when a non-fatal event happens that needs reporting.
(Inherited from DocumentViewer.)
Public eventMissingPage
Raised when the viewer wants to show a particular page that is not in the current page selection.
(Inherited from DocumentViewer.)
Public eventPageInteractorCreated
Fired after an interactor has been created for a page.
(Inherited from DocumentViewer.)
Public eventPreviewDragDrop
DragDrop preview event.
(Inherited from DocumentViewer.)
Public eventPreviewDragOver
DragOver preview event.
(Inherited from DocumentViewer.)
Public eventPreviewMouseDown
MouseDown preview event.
(Inherited from DocumentViewer.)
Public eventPreviewMouseMove
MouseMove preview event.
(Inherited from DocumentViewer.)
Public eventPreviewMouseUp
MouseUp preview event.
(Inherited from DocumentViewer.)
Public eventTextSelectModeChanged
Raised when the TextSelectMode property changes. You typically handle this event to update the UI of your application, such as e.g. a tool bar.
Public eventUnhandledException
Raised when an exception occurs that is not handled by the library at a point that is not invoked by user code (e.g. during an OnPaint event).
(Inherited from DocumentViewer.)
Public eventVisibleRectangleChanged
Raised after the VisibleRectangle has changed.
(Inherited from DocumentViewer.)
Public eventZoomFactorChanged
Raised after the ZoomFactor has changed. You typically handle this event to update the UI of your reader, such as e.g. a tool bar.
(Inherited from DocumentViewer.)
Public eventZoomModeChanged
Raised when the ZoomMode property changes. You typically handle this event to update the UI of your application, such as e.g. a tool bar.

See Also