The DocumentViewer type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | DocumentViewer |
Create a new instance of the PagesViewer control.
|
Methods
| Name | Description | |
|---|---|---|
| BeginUpdate |
Call this method in pairs with EndUpdate. In between these calls, the control is not updated.
|
 | Dispose |
Clean up any resources being used.
(Overrides Control..::..Dispose(Boolean).) |
| EndUpdate |
Call this method in pairs with BeginUpdate. In between these calls, the control is not updated.
|
| EnsureVisible |
Scroll the given rectangle into view.
|
| FindPage |
Find the page at a given position.
|
| GetIntersecting |
Returns a subset of a collection of interactors that overlap with the given rectangle.
|
| 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.
|
 | GetPdfPageTransform |
Returns a transformation that transforms coordinates from PDF page space (with the origin
at the lower left of the page) to "winforms" page space, i.e. with the origin
at the upper left corner of the page.
If no document is present, or the specified page is not present, the identity
transformation will be returned.
|
| GoToDestination |
Navigate to the given destination.
|
| OnAnnotationInteractorCreated |
Invoked after an annotation interactor gets created.
|
| OnClose |
Invoked just before a document will be closed.
|
| OnDocumentInteractorCreated |
Invoked after a document interactor gets created.
|
| OnDragDrop |
Raises the DragDrop event and dispatches the event to the interactor that the
mouse is over.
(Overrides Control..::..OnDragDrop(DragEventArgs).) |
| OnDragEnter |
Raises the DragEnter event and prepares the document viewer for
dragging.
(Overrides Control..::..OnDragEnter(DragEventArgs).) |
| OnDragLeave |
Raises the DragLeave event.
(Overrides Control..::..OnDragLeave(EventArgs).) |
| OnDragOver |
Raises the DragOver event and dispatches the event to the interactor that the
mouse is over.
(Overrides Control..::..OnDragOver(DragEventArgs).) |
| OnFocusChanged |
Invoked when the focus of the document viewer changes.
|
| OnGotFocus |
Invoked after the DocumentViewer control got the focus.
(Overrides Control..::..OnGotFocus(EventArgs).) |
| OnKeyDown |
Invoked when the document viewer receives a KeyDown event. This
method will first raise the KeyDown 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.
(Overrides Control..::..OnKeyDown(KeyEventArgs).) |
| 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.
(Overrides Control..::..OnKeyPress(KeyPressEventArgs).) |
| 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.
(Overrides Control..::..OnKeyUp(KeyEventArgs).) |
| OnMissingPage | |
| OnMouseDown |
Raises the System.Windows.Forms.Control.MouseDown event.
(Overrides Control..::..OnMouseDown(MouseEventArgs).) |
| OnMouseMove |
Raises the System.Windows.Forms.Control.MouseMove event.
(Overrides Control..::..OnMouseMove(MouseEventArgs).) |
| OnMouseUp |
Raises the System.Windows.Forms.Control.MouseUp event.
(Overrides Control..::..OnMouseUp(MouseEventArgs).) |
| OnMouseWheel |
Raises the System.Windows.Forms.Control.MouseWheel event.
(Overrides Control..::..OnMouseWheel(MouseEventArgs).) |
| OnOpen |
Invoked after a document has been opened.
|
| OnPageInteractorCreated |
Invoked after a page interactor gets created.
|
| OnPaint |
Raises the System.Windows.Forms.Paint event.
(Overrides Control..::..OnPaint(PaintEventArgs).) |
| OnVisibleRectangleChanged |
Invoked when the visible rectangle of the document viewer changes.
|
| OnZoomFactorChanged |
Invoked when the zoom factor of the document viewer changes.
|
| ProcessCmdKey | (Overrides Control..::..ProcessCmdKey(Message%, Keys).) |
| SelectText |
Scrolls into view and selects the text match.
|
| ZoomTo |
Zoom to the given center point, using the specified zoom factor.
|
| ZoomToRectangle |
Zoom to a given rectangle.
|
| ZoomToWidth |
Zoom to make the width of the document fit exactly in the reader window.
|
Properties
| Name | Description | |
|---|---|---|
 | ActionHandler |
This ActionHandler is responsible for executing actions that triggered
by this viewer.
|
| AnnotationInteractorFactory |
The annotation interactor factory. This factory will be used to
create annotation interactors when a page becomes visible.
|
| CaretBlinkTime |
The blink time of the caret, in milliseconds.
|
| CursorPosition |
The current position of the cursor, with respect to the viewer.
|
| Document |
The PDF document that holds the pages that are displayed by this control.
|
| DocumentInteractor |
The document interactor of the document viewer.
|
| DocumentInteractorFactory |
The document interactor factory. This factory will be used to
create a document interactor when opening a document.
|
| DocumentToClientTransform |
Returns a transformation that transforms coordinates from document space to client space.
If no document is present, the identity transformation will be returned.
|
| FocusAnnotation |
The annotation that currently has the input focus. If this property is null, no annotation has
the focus (but another interactor may have).
|
| FocusInteractor |
The interactor that currently has the input focus. If this property is null, no interactor has
the focus.
|
| HideHorizontalScrollbar |
Hide the horizontal scrollbar.
|
| HideVerticalScrollbar |
Hide the vertical scrollbar.
|
| HorizontalAlignment |
Horizontal alignment of the document rectangle inside the viewer window.
|
| HoverCursor |
The cursor that is shown when the mouse hovers over the viewer.
|
| HoverInteractor |
The interactor that the mouse is over. If null, the mouse is not
hovering over an interactor.
|
| IsPainting |
True while the viewer still has painting operations queued (due to
progressive drawing for example).
|
| LayoutManager |
The layout manager determines the layout of all (page) interactors of the
document.
|
| MaxZoom |
The maximum zoom factor. The zoom factor will never be greater than this value.
|
| MinZoom |
The minimum zoom factor. The zoom factor will never be smaller than this value.
|
| PageInteractorFactory |
The page interactor factory. This factory will be used to
create a page interactors when they come into view.
|
| PageSelection |
The selection of pages that is shown. Only pages
that exist in the document are shown. If null,
all pages are shown.
|
| RenderSettings |
The render settings of the viewer.
|
| Selection |
The current collection of selected interactors.
|
| VerticalAlignment |
Vertical alignment of the document rectangle inside the viewer window.
|
| ViewerSettings |
The viewer settings.
|
| VisibleHeight |
The height of the visible rectangle in document space.
|
| VisibleLeft |
The horizontal position of the left edge of the visible rectangle in document space.
|
| VisibleTop |
The vertical position of the top edge of the visible rectangle in document space.
|
| VisibleWidth |
The width of the visible rectangle in document space.
|
| 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.
|
Events
| Name | Description | |
|---|---|---|
 | AnnotationInteractorCreated |
Fired after an interactor has been created for an annotation.
|
| DocumentInteractorCreated |
Fired after an interactor has been created for a document.
|
| FocusChanged |
Raised after the focus has changed.
|
| HoverChanged |
Raised when the mouse starts hovering over a different interactor.
|
| Message |
Raised when a non-fatal event happens that needs reporting.
|
| MissingPage |
Raised when the viewer wants to show a particular page that is not in the current page
selection.
|
| PageInteractorCreated |
Fired after an interactor has been created for a page.
|
| PreviewDragDrop |
DragDrop preview event.
|
| PreviewDragOver |
DragOver preview event.
|
| PreviewMouseDown |
MouseDown preview event.
|
| PreviewMouseMove |
MouseMove preview event.
|
| PreviewMouseUp |
MouseUp preview event.
|
| 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).
|
| VisibleRectangleChanged |
Raised after the VisibleRectangle has changed.
|
| 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.
|
See Also
