The StandardPagesViewer type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| StandardPagesViewer |
Creates a new PagesViewer with a default action handler and interactor factories that take into
account the CursorMode of the PagesViewer.
|
Methods
| Name | Description | |
|---|---|---|
| BeginUpdate |
Call this method in pairs with EndUpdate. In between these calls, the control is not updated.
(Inherited from DocumentViewer.) | |
| Dispose |
Closes and Disposes the pagesviewer.
(Inherited from PagesViewer.) | |
| EndUpdate |
Call this method in pairs with BeginUpdate. In between these calls, the control is not updated.
(Inherited from DocumentViewer.) | |
| EnsureVisible |
Scroll the given rectangle into view.
(Inherited from DocumentViewer.) | |
| FindPage |
Find the page at a given position.
(Inherited from DocumentViewer.) | |
| GetIntersecting |
Returns a subset of a collection of interactors that overlap with the given rectangle.
(Inherited from DocumentViewer.) | |
| GetPageToDocumentTransform |
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.) | |
| GoToDestination |
Navigate to the given destination.
(Inherited from DocumentViewer.) | |
| GoToNextPage |
Navigate to the next page.
(Inherited from PagesViewer.) | |
| GoToPreviousPage |
Navigate to the previous page. Also see GoToNextPage.
(Inherited from PagesViewer.) | |
| OnAnnotationInteractorCreated |
Invoked after a new annotation interactor got created.
(Overrides DocumentViewer..::..OnAnnotationInteractorCreated(InteractorEventArgs).) | |
| OnClose |
Invoked just before a document gets closed.
(Inherited from PagesViewer.) | |
| OnCurrentPageChanged |
This override adjust the document layout when the current page changes.
(Overrides PagesViewer..::..OnCurrentPageChanged(EventArgs).) | |
| OnDocumentInteractorCreated |
Invoked after a new document interactor got created.
(Overrides DocumentViewer..::..OnDocumentInteractorCreated(InteractorEventArgs).) | |
| OnDragDrop |
Raises the DragDrop event and dispatches the event to the interactor that the
mouse is over.
(Inherited from DocumentViewer.) | |
| OnDragEnter |
Raises the DragEnter event and prepares the document viewer for
dragging.
(Inherited from DocumentViewer.) | |
| OnDragLeave |
Raises the DragLeave event.
(Inherited from DocumentViewer.) | |
| OnDragOver |
Raises the DragOver event and dispatches the event to the interactor that the
mouse is over.
(Inherited from DocumentViewer.) | |
| OnFocusChanged |
This override put the annotation interactor that gets the focus
in the current selection.
(Overrides DocumentViewer..::..OnFocusChanged(EventArgs).) | |
| OnGotFocus |
Invoked after the DocumentViewer control got the focus.
(Inherited from DocumentViewer.) | |
| OnKeyDown |
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.) | |
| OnKeyPress |
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.) | |
| OnKeyUp |
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.) | |
| OnMissingPage | (Overrides DocumentViewer..::..OnMissingPage(ElementEventArgs<(Of <<'(Page>)>>)).) | |
| OnMouseDown |
Raises the System.Windows.Forms.Control.MouseDown event.
(Inherited from DocumentViewer.) | |
| OnMouseMove |
Raises the System.Windows.Forms.Control.MouseMove event.
(Inherited from DocumentViewer.) | |
| OnMouseUp |
Raises the System.Windows.Forms.Control.MouseUp event.
(Inherited from DocumentViewer.) | |
| OnMouseWheel |
This override implements scrolling through pages.
(Inherited from PagesViewer.) | |
| OnOpen |
This override updates the zoom factor in accordance with the zoom mode.
(Overrides PagesViewer..::..OnOpen(EventArgs).) | |
| OnPageInteractorCreated |
Invoked after a page interactor gets created.
(Inherited from DocumentViewer.) | |
| OnPaint |
Raises the System.Windows.Forms.Paint event.
(Inherited from DocumentViewer.) | |
| OnResize |
This override updates the zoom factor in accordance with the zoom mode.
(Overrides Control..::..OnResize(EventArgs).) | |
| OnVisibleChanged |
This override updates the zoom factor in accordance with the zoom mode.
(Overrides Control..::..OnVisibleChanged(EventArgs).) | |
| OnVisibleRectangleChanged |
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:
(Inherited from PagesViewer.)
| |
| OnZoomFactorChanged |
This override updates the zoom mode, if necessary.
(Overrides DocumentViewer..::..OnZoomFactorChanged(EventArgs).) | |
Print the document shown in this pages viewer with a print dialog.
(Inherited from PagesViewer.) | ||
| ProcessCmdKey | (Inherited from DocumentViewer.) | |
| RotatePageLeft |
Rotate a page to the left.
| |
| RotatePageRight |
Rotate a page to the right.
| |
| SelectText |
Scrolls into view and selects the text match.
(Inherited from DocumentViewer.) | |
| ZoomIn |
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.
| |
| ZoomOut |
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.
| |
| ZoomTo |
Zoom to the given center point, using the specified zoom factor.
(Inherited from DocumentViewer.) | |
| ZoomToActualSize |
Zoom to the actual size of the PDF page assuming a 72 DPI display.
| |
| ZoomToFitPage |
Change the zoom factor so that the current entire page fits exactly.
(Inherited from PagesViewer.) | |
| ZoomToRectangle |
Zoom to a given rectangle.
(Inherited from DocumentViewer.) | |
| ZoomToWidth |
Zoom to make the width of the document fit exactly in the reader window.
(Inherited from DocumentViewer.) |
Properties
| Name | Description | |
|---|---|---|
| ActionHandler |
This ActionHandler is responsible for executing actions that triggered
by this viewer.
(Inherited from DocumentViewer.) | |
| AnnotationInteractorFactory |
The annotation interactor factory. This factory will be used to
create annotation interactors when a page becomes visible.
(Inherited from DocumentViewer.) | |
| CaretBlinkTime |
The blink time of the caret, in milliseconds.
(Inherited from DocumentViewer.) | |
| CurrentDestination |
Returns the current location as an InternalDestination.
(Inherited from PagesViewer.) | |
| CurrentPageIndex |
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.) | |
| CursorMode |
The cursormode controls how the PagesViewer reacts to mouse events.
| |
| CursorPosition |
The current position of the cursor, with respect to the viewer.
(Inherited from DocumentViewer.) | |
| Document |
The PDF document that holds the pages that are displayed by this control.
(Inherited from DocumentViewer.) | |
| DocumentInteractor |
The document interactor of the document viewer.
(Inherited from DocumentViewer.) | |
| DocumentInteractorFactory |
The document interactor factory. This factory will be used to
create a document interactor when opening a document.
(Inherited from DocumentViewer.) | |
| DocumentMargin |
The margin in points.
| |
| DocumentToClientTransform |
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.) | |
| EnableAnnotations |
Controls whether annotations and form fields respond to user input.
| |
| FocusAnnotation |
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.) | |
| FocusInteractor |
The interactor that currently has the input focus. If this property is null, no interactor has
the focus.
(Inherited from DocumentViewer.) | |
| HideHorizontalScrollbar |
Hide the horizontal scrollbar.
(Inherited from DocumentViewer.) | |
| HideVerticalScrollbar |
Hide the vertical scrollbar.
(Inherited from DocumentViewer.) | |
| HighlightAnnotations |
If true, all active annotations will be highlighted.
| |
| HighlightFields |
If true, all active fields will be highlighted.
| |
| HorizontalAlignment |
Horizontal alignment of the document rectangle inside the viewer window.
(Inherited from DocumentViewer.) | |
| HoverCursor |
The cursor that is shown when the mouse hovers over the viewer.
(Inherited from DocumentViewer.) | |
| HoverInteractor |
The interactor that the mouse is over. If null, the mouse is not
hovering over an interactor.
(Inherited from DocumentViewer.) | |
| IsPainting |
True while the viewer still has painting operations queued (due to
progressive drawing for example).
(Inherited from DocumentViewer.) | |
| LayoutManager |
The layout manager determines the layout of all (page) interactors of the
document.
(Inherited from DocumentViewer.) | |
| MaxZoom |
The maximum zoom factor. The zoom factor will never be greater than this value.
(Inherited from DocumentViewer.) | |
| MinZoom |
The minimum zoom factor. The zoom factor will never be smaller than this value.
(Inherited from DocumentViewer.) | |
| PageInteractorFactory |
The page interactor factory. This factory will be used to
create a page interactors when they come into view.
(Inherited from DocumentViewer.) | |
| PageLayout |
The PageLayout mode controls how the current document or pages collection is laid out
on the viewer canvas.
| |
| PageSelection |
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.) | |
| PageSpacing |
The spacing in points.
| |
| RenderSettings |
The render settings of the viewer.
(Inherited from DocumentViewer.) | |
| SelectedText |
The currently selected text.
| |
| Selection |
The current collection of selected interactors.
(Inherited from DocumentViewer.) | |
| ShowOverflowMarker |
If true, an overflow marker will be shown if text cannot be displayed
entirely in a widget.
| |
| TextSelectMode |
The TextSelectMode controls text selection behavior while CursorMode is
SelectText.
| |
| VerticalAlignment |
Vertical alignment of the document rectangle inside the viewer window.
(Inherited from DocumentViewer.) | |
| ViewerSettings |
The viewer settings.
(Inherited from DocumentViewer.) | |
| VisibleHeight |
The height of the visible rectangle in document space.
(Inherited from DocumentViewer.) | |
| VisibleLeft |
The horizontal position of the left edge of the visible rectangle in document space.
(Inherited from DocumentViewer.) | |
| VisibleTop |
The vertical position of the top edge of the visible rectangle in document space.
(Inherited from DocumentViewer.) | |
| VisibleWidth |
The width of the visible rectangle in document space.
(Inherited from DocumentViewer.) | |
| ZoomFactor |
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.) | |
| ZoomFactors |
An array of zoom factors that are used by ZoomIn and ZoomOut to determine the next factor.
| |
| ZoomMode |
The zoom mode of the viewer.
|
Events
| Name | Description | |
|---|---|---|
| AnnotationInteractorCreated |
Fired after an interactor has been created for an annotation.
(Inherited from DocumentViewer.) | |
| CurrentPageChanged |
Raised after the CurrentPage has changed.
(Inherited from PagesViewer.) | |
| CursorModeChanged |
Raised when the CursorMode changes. You typically handle this event to update the UI of your application,
such as e.g. a tool bar.
| |
| DocumentInteractorCreated |
Fired after an interactor has been created for a document.
(Inherited from DocumentViewer.) | |
| FocusChanged |
Raised after the focus has changed.
(Inherited from DocumentViewer.) | |
| HoverChanged |
Raised when the mouse starts hovering over a different interactor.
(Inherited from DocumentViewer.) | |
| Message |
Raised when a non-fatal event happens that needs reporting.
(Inherited from DocumentViewer.) | |
| MissingPage |
Raised when the viewer wants to show a particular page that is not in the current page
selection.
(Inherited from DocumentViewer.) | |
| PageInteractorCreated |
Fired after an interactor has been created for a page.
(Inherited from DocumentViewer.) | |
| PreviewDragDrop |
DragDrop preview event.
(Inherited from DocumentViewer.) | |
| PreviewDragOver |
DragOver preview event.
(Inherited from DocumentViewer.) | |
| PreviewMouseDown |
MouseDown preview event.
(Inherited from DocumentViewer.) | |
| PreviewMouseMove |
MouseMove preview event.
(Inherited from DocumentViewer.) | |
| PreviewMouseUp |
MouseUp preview event.
(Inherited from DocumentViewer.) | |
| TextSelectModeChanged |
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.
| |
| UnhandledException |
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.) | |
| VisibleRectangleChanged |
Raised after the VisibleRectangle has changed.
(Inherited from DocumentViewer.) | |
| ZoomFactorChanged |
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.) | |
| ZoomModeChanged |
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.
|