The StandardDocumentInteractor type exposes the following members.

Constructors

  NameDescription
Public methodStandardDocumentInteractor
Creates a new document interactor for the given document that takes into account the cursor mode if it gets attached to a CursorModePagesViewer.

Methods

  NameDescription
Public methodCreateOrientationTransform
Create a transformation that applies the given orientation to the interactor.
(Inherited from Interactor.)
Public methodEnsureVisible
Makes sure that the viewer scrolls this interactor into view.
(Inherited from WinFormsInteractor.)
Public methodFindPageInteractor
Returns the page interactor that controls the given page, if any.
(Inherited from DocumentInteractor.)
Public methodInvalidate
Invoke this method to mark the apearance of this interactor invalid, so that it gets repainted.
(Inherited from Interactor.)
Protected methodIsOver
Specifies whether a certain coordinate is considered to be part of the interactor. This can be used for irregularly shaped interactors, or interactors with "holes". By default, this method returns true, which means that all coordinates within the interactor Rectangle are included.
(Inherited from Interactor.)
Protected methodOnAttached
Tries to attach to a StandardPagesViewer instance.
(Overrides Interactor..::..OnAttached(EventArgs).)
Protected methodOnDeselected
Invoked when the interactor got removed from the current selection.
(Inherited from WinFormsInteractor.)
Protected methodOnDetached
Detaches this interactor.
(Overrides DocumentInteractor..::..OnDetached(EventArgs).)
Protected methodOnDragBegin
Invoked when the user starts to drag this interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnDragDrop
Invoked when another object is dropped on this interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnDragEnd
Invoked after the user has dragged this interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnDragEnter
Invoked when another object gets dragged into this interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnDragLeave
Invoked when another object gets dragged outside the interactor, or when dragging gets cancelled.
(Inherited from WinFormsInteractor.)
Protected methodOnDragOver
Invoked when another object is dragged over this interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnDragSelectMouseDown
Invoked when the mouse went down to drag a selection.
(Inherited from WinFormsInteractor.)
Protected methodOnDragSelectMouseMove
Invoked while dragging a selection when the selection rectangle overlaps this interactor. This method will add the corresponding interactor to the current selection if Selectable is true.
(Inherited from WinFormsInteractor.)
Protected methodOnDragSelectMouseUp
Zooms to the drag box if the cursor mode is ZoomToSelection.
(Overrides WinFormsInteractor..::..OnDragSelectMouseUp(DragSelectEventArgs).)
Protected methodOnGotFocus
Invoked after the interactor got the focus.
(Inherited from WinFormsInteractor.)
Protected methodOnKeyDown
Raised when a key is pressed while this interactor has the focus.
(Inherited from WinFormsInteractor.)
Protected methodOnKeyUp
Raised when a key is released while this interactor has the focus.
(Inherited from WinFormsInteractor.)
Protected methodOnLostFocus
Invoked after the interactor lost the focus.
(Inherited from WinFormsInteractor.)
Protected methodOnMouseClick
Invoked when the mouse is clicked in the interactor, i.e. a mouse down event has occurred and the mouse button has been released in the interactor as well.
(Inherited from WinFormsInteractor.)
Protected methodOnMouseDoubleClick
Invoked when a double-click occurs in the interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnMouseDown
Zooms in or out if the cursormode is ZoomIn or ZoomOut. Maps to base functionality otherwise.
(Overrides WinFormsInteractor..::..OnMouseDown(MouseEventArgs).)
Protected methodOnMouseEnter
Invoked when the mouse enters the interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnMouseHover
Invoked afer the mouse stays a short period of time in this interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnMouseLeave
Invoked when the mouse leaves the interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnMouseMove
Invoked when the mouse moves over this interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnMouseUp
Invoked when the mouse button goes up in the interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnPageInteractorsCreated
Invoked after the child page interactors have been created, but before their annotations have been layed out. Override this method to additional child interactors.
(Inherited from DocumentInteractor.)
Protected methodOnPaint
Invoked when the interactor must paint itself.
(Inherited from WinFormsInteractor.)
Protected methodOnPaintDrag
Invoked when the interactor must paint a drag representation of itself.
(Inherited from WinFormsInteractor.)
Protected methodOnPaintOver
This method will be invoked after all child interactors have been painted.
(Inherited from WinFormsInteractor.)
Protected methodOnPaintShadow
Invoked to paint a shadow for this interactor.
(Inherited from WinFormsInteractor.)
Protected methodOnSelected
Invoked when the interactor got added to the current selection.
(Inherited from WinFormsInteractor.)
Public methodSendText
Sends the given text to the interator.
(Inherited from WinFormsInteractor.)

Properties

  NameDescription
Public propertyChilds
The child interactors of this interactor. This property may be null.
(Inherited from Interactor.)
Public propertyDocument
The document that this interactor controls.
(Inherited from DocumentInteractor.)
Public propertyDragBehavior
Controls the dragging behavior of the interactor.
(Inherited from WinFormsInteractor.)
Public propertyHeight
The height of the document interactor. This is derived from the actual layout the of the pages.
(Inherited from DocumentInteractor.)
Public propertyHoverCursor
Returns a zoom cursor, if the cursor mode is one of the zoom modes. Maps to the base cursor otherwise.
(Overrides WinFormsInteractor..::..HoverCursor.)
Public propertyIsInteractive
Controls whether an interactor can be interacted with.
(Inherited from Interactor.)
Public propertyLayers
The layers of this interactor.
(Inherited from Interactor.)
Public propertyLayoutManager
The layout property controls the placement of sub-interactors relative to this one. This property may be null.
(Inherited from Interactor.)
Public propertyObject
The controlled object.
(Inherited from Interactor.)
Public propertyOpacity
A value between 0 and 1 that specifies the opacity of the interactor. 1 means fully opaque, 0 means fully transparent (i.e. invisible). The default is 1.
(Inherited from Interactor.)
Public propertyPageSelection
The selection of pages that is shown by this interactor. Only pages that exist in the document are shown. If null, all pages are shown.
(Inherited from DocumentInteractor.)
Public propertyParent
The interactor that this interactor is a child of.
(Inherited from Interactor.)
Public propertyRectangle
The rectangle that this interactor occupies, including the space taken by its layers.
(Inherited from Interactor.)
Public propertyShadowDistance
The distance at which the shadow of the interactor will be drawn. This distance is relative to the parent, so that transformations on this interactor (such as rotations) do not influence the location of the shadow.
(Inherited from WinFormsInteractor.)
Public propertyToolTip
The tooltip for this interactor. Override this to return the proper information for this interactor. If null, no tooltip will be shown.
(Inherited from Interactor.)
Public propertyTransform
Transformation that is applied to the interactor before drawing, relative to the origin of its parent, i.e.:
  • If one applies this transformation to a local coordinate, one obtains the coordinates in the coordinate system of the parent.
  • If one uses this transformation to transform the parent coordinate system (CTM), one obtains the local coordinate system.
(Inherited from Interactor.)
Public propertyViewer
The viewer that this interactor is located in.
(Inherited from WinFormsInteractor.)
Public propertyViewerTransform
Transforms coordinates in the local coordinate system to the coordinate system of the viewer, i.e.:
  • If one applies this transformation to a local coordinate, one obtains the coordinates in the coordinate system of the viewer.
  • If one uses this transformation to transform the original viewer coordinate system (CTM), one obtains the local coordinate system.
(Inherited from Interactor.)
Public propertyVisibleRectangle
A rectangle that defines a the visible part of the interactor, in terms of its own coordinate system.
(Inherited from Interactor.)
Public propertyWidth
The width of the document presentation. This is derived from the actual layout the of the pages.
(Inherited from DocumentInteractor.)

Events

  NameDescription
Public eventPageInteractorsCreated
This event will be raised after the interactor has initialised its child page interactors.
(Inherited from DocumentInteractor.)
Public eventPreviewDragBegin
DragBegin preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewDragDrop
DragDrop preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewDragEnd
DragEnd preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewDragEnter
DragEnter preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewDragLeave
DragLeave preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewDragOver
DragOver preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewDragSelectMouseDown
DragSelectMouseDown preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewDragSelectMouseMove
DragSelectMouseMove preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewDragSelectMouseUp
DragSelectMouseUp preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewMouseDown
MouseDown preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewMouseMove
MouseMove preview event.
(Inherited from WinFormsInteractor.)
Public eventPreviewMouseUp
MouseUp preview event.
(Inherited from WinFormsInteractor.)

See Also