| Name | Description | |
|---|---|---|
 | OverlayImageTool | Initializes a new instance of the OverlayImageTool class. |
OverlayImageTool Class Members
In This Topic
The following tables list the members exposed by OverlayImageTool.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | ActionButton | Gets or sets the mouse button which executes the action of this tool. (Inherited from RectangularSelectionTool) |
| ActionCursor | Gets or sets a cursor, which should be used in image viewer when visual tool executes its action. (Inherited from VisualTool) |
| ActiveInteractionController | Gets an active interaction controller. (Inherited from UserInteractionVisualTool) |
| AllowNextItemSelection | Gets or sets a value indicating whether the tool allows changing focused item using the PerformNextItemSelection(Boolean) method. (Inherited from VisualTool) |
| BackColor | Gets or sets a background color of the selection rectangle. (Inherited from RectangularSelectionTool) |
| BorderColor | Gets or sets a border color of the selection rectangle. (Inherited from RectangularSelectionTool) |
| CanModifyImage | Gets a value indicating whether this visual tool can modify the image. |
| ChangeFocusedItemBeforeInteraction | Gets or sets a value indicating whether focused item can be changed before interaction. (Inherited from UserInteractionVisualTool) |
| Clipboard | Gets or sets the clipboard of this tool. (Inherited from UserInteractionVisualTool) |
| Cursor | Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool) |
| DisableContextMenu | Gets or sets a value indicating whether image viewer must disable context menu in image viewer if the right mouse button is set as an action button of the visual tool. (Inherited from VisualTool) |
| DragButton | Gets or sets the mouse button which starts the dragging of selected area. |
| DragCursor | Gets or sets the cursor of this tool when selection is dragging. |
| DropButton | Gets or sets the mouse button which drops the selected area to the new location. |
| Enabled | Gets or sets a value indicating whether VisualTool can respond to the user interaction. (Inherited from VisualTool) |
| Image | Gets or sets the overlay image. |
| ImageViewer | Gets the ImageViewer object associated with this tool. (Inherited from VisualTool) |
| InteractionController | Gets or sets an interaction controller of rectangular selection. |
| IsFinishInteractionOnLostFocus | Gets or sets a value indicating whether interaction should be finished when focus is lost. (Inherited from UserInteractionVisualTool) |
| IsMultipageModeSupported | Gets a value indicating whether this tool supports multipage mode. (Inherited from VisualTool) |
| IsVisibleWithoutImage | Gets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from VisualTool) |
| MaintainAspectRatio | Gets or sets a value indicating whether visual tool must maintain the aspect ratio of image. |
| Name | Gets the name of the visual tool. |
| OveralyOnUnfocusedImages | Gets or sets a value indicating whether visual tool must overlay image onto unfocused images in multipage viewer mode. |
| Rectangle | Gets or sets a rectangle, in pixels, that defines rectangular selection on image. (Inherited from RectangularSelectionTool) |
| SelectionOnlyOnImage | Gets or sets a value indicating whether selection can be used only on image area. (Inherited from RectangularSelectionTool) |
| SelectNextItemKeyCode | Gets or sets a key code that changes the selected item to the next item. (Inherited from VisualTool) |
| SelectPrevItemKeyCode | Gets or sets a key code that changes the selected item to the previous item. (Inherited from VisualTool) |
| TransformController | Gets or sets a transform interaction controller of rectangular selection. (Inherited from RectangularSelectionTool) |
Protected Properties
| Name | Description | |
|---|---|---|
 | CanBeginInteractionAfterSetFocusedItem | Gets or sets a value indicating whether the interaction can be started right after the interactive object is selected. (Inherited from UserInteractionVisualTool) |
| CanUserSetFocusedItem | Gets or sets a value indicating whether user can set the focused interactive object. (Inherited from UserInteractionVisualTool) |
| EnableViewerInvalidate | Gets or sets a value indicating whether viewer must be invalidated when InvalidateViewer method is executed. (Inherited from VisualTool) |
| FocusedItem | Gets or sets a focused item. (Inherited from UserInteractionVisualTool) |
| InvokeRequired | Gets a value indicating whether the caller must call an invoke method when making method calls to the VisualTool because the caller is on a different thread than the one the VisualTool was created on. (Inherited from VisualTool) |
| Items | Gets a collection of IInteractiveObject. (Inherited from UserInteractionVisualTool) |
| MouseClickCount | Gets the count of mouse clicks in series of clicks. (Inherited from VisualTool) |
| MouseClicksDelta | Gets or sets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from VisualTool) |
| RectangleF | Gets or sets a real rectangle that defines rectangular selection on image. (Inherited from RectangularSelectionTool) |
| UseActionButtonToInteractionController | Gets a value indicating whether interaction controller should use ActionButton of visual tool. (Inherited from UserInteractionVisualTool) |
| UseRoundingPointTransform | Gets a value indicating whether this tool need to use rounding transform for transforming points in the selection rectangle. (Inherited from RectangularSelectionTool) |
Public Methods
| Name | Description | |
|---|---|---|
 | BeginBuilding | Begins building of selection. (Inherited from RectangularSelectionTool) |
| CancelActiveInteraction | Cancels an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool) |
| Dispose | Overloaded. Releases all resources used by the |
| Draw | Draws the selection on specified System.Drawing.Graphics. |
 | FindVisualTool<T> | Finds the specified visual tool of specified type in visual tool. (Inherited from VisualTool) |
| FinishActiveInteraction | Finishes an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool) |
| GetActiveInteractionController | Overloaded. Returns the active interaction controller of specified visual tool. (Inherited from UserInteractionVisualTool) |
| GetDrawingBox | Returns a drawing rectangle of selection. (Inherited from RectangularSelectionTool) |
| GetSupportedUIActions | Returns the supported UI actions. (Inherited from UserInteractionVisualTool) |
| InvalidateFocusedItem | Invalidates a drawing box of focused interactive object. (Inherited from UserInteractionVisualTool) |
| InvalidateItem | Invalidates a drawing box of specified interactive object. (Inherited from UserInteractionVisualTool) |
| Overlay | Overlays an image on a top of image in image viewer. |
| PerformNextItemSelection | Selects the next available item and makes it as the active item. (Inherited from UserInteractionVisualTool) |
| ScrollToFocusedItem | Scrolls the viewer to the focused item. (Inherited from UserInteractionVisualTool) |
| ToString | Returns the string representation of this object. (Inherited from VisualTool) |
Protected Methods
| Name | Description | |
|---|---|---|
 | BeginInteraction | Begins an active interaction. (Inherited from UserInteractionVisualTool) |
| CanChangeFocusedItem | Determines that focused item can be changed. (Inherited from UserInteractionVisualTool) |
| CanSelectNextItem | Returns a value indicating whether next item can be selected. (Inherited from UserInteractionVisualTool) |
| CheckIsPointOnUnfocusedImage | Returns a value indicating whether the point is located on unfocused image. (Inherited from UserInteractionVisualTool) |
| DrawItem | Draws an interactive object on specified graphics. (Inherited from UserInteractionVisualTool) |
| FindInteractionArea | Finds the interaction area at the specified location, in viewer space. (Inherited from UserInteractionVisualTool) |
| FindInteractiveObject | Finds an interactive object at specified point on image viewer. (Inherited from UserInteractionVisualTool) |
| FinishInteraction | Finishes an active interaction. (Inherited from RectangularSelectionTool) |
| GetItemDrawingBox | Returns the item drawing box. (Inherited from UserInteractionVisualTool) |
| GetPointsTransform | Returns a point transformation of specified interactive object. (Inherited from UserInteractionVisualTool) |
| InvalidateViewer | Overloaded. Invalidates the specified region of the |
| Invoke | Overloaded. Executes the specified delegate, on the thread that owns the |
| IsActionButtonContains | Determines whether the ActionButton contains the button. (Inherited from VisualTool) |
| NeedProcessMouseEvent | Returns a value indicating whether the visual tool will process the mouse event. |
| OnActivated | Raises the Activated event. (Inherited from RectangularSelectionTool) |
| OnActivating | Raises the Activating event. (Inherited from VisualTool) |
| OnActiveInteractionControllerChanged | Raises the ActiveInteractionControllerChanged event. (Inherited from UserInteractionVisualTool) |
| OnBuildingFinished | Raises the BuildingFinished event. (Inherited from RectangularSelectionTool) |
| OnBuildingStarted | Raises the BuildingFinished event. (Inherited from RectangularSelectionTool) |
| OnDeactivated | Raises the Deactivated event. (Inherited from RectangularSelectionTool) |
| OnDeactivating | Raises the Deactivating event. (Inherited from VisualTool) |
| OnEnabledChanged | Raises the EnabledChanged event. (Inherited from VisualTool) |
| OnFocusedItemChanged | Occurs when focused item is changed. (Inherited from UserInteractionVisualTool) |
| OnFocusedItemChanging | Occurs when focused item is changing. (Inherited from UserInteractionVisualTool) |
| OnImageChanged | Raises the ImageChanged event. (Inherited from VisualTool) |
| OnImageChanging | Raises the ImageChanging event. (Inherited from VisualTool) |
| OnImageLoadingException | Raises the ImageLoadingException event. (Inherited from VisualTool) |
| OnInteraction | Raises the interaction event for specified interactive object. (Inherited from UserInteractionVisualTool) |
| OnItemCollectionChanged | Called when item collection is changed. (Inherited from UserInteractionVisualTool) |
| OnItemStateChanged | Occurs when state of interactive object is changed. (Inherited from UserInteractionVisualTool) |
| OnKeyDown | Raises the KeyDown event. |
| OnKeyUp | Raises the KeyUp event. (Inherited from UserInteractionVisualTool) |
| OnLostFocus | Occurs when visual tool loses the focus. (Inherited from UserInteractionVisualTool) |
| OnMouseClick | Raises the MouseClick event. (Inherited from VisualTool) |
| OnMouseDoubleClick | Raises the MouseDoubleClick event. (Inherited from VisualTool) |
| OnMouseDown | Raises the MouseDown event. (Inherited from RectangularSelectionTool) |
| OnMouseEnter | Raises the MouseEnter event. (Inherited from VisualTool) |
| OnMouseLeave | Raises the MouseLeave event. (Inherited from VisualTool) |
| OnMouseMove | Raises the MouseMove event. (Inherited from UserInteractionVisualTool) |
| OnMouseUp | Raises the MouseUp event. (Inherited from UserInteractionVisualTool) |
| OnMouseWheel | Raises the MouseWheel event. (Inherited from VisualTool) |
| OnPaint | Overloaded. Paints content of visual tool. (Inherited from UserInteractionVisualTool) |
| OnPreviewKeyDown | Raises the PreviewKeyDown event. (Inherited from VisualTool) |
| OnSelectionChanged | Raises the SelectionChanged event. (Inherited from RectangularSelectionTool) |
| OnStateChanged | Occurs when state of rectangular selection tool is changed. (Inherited from RectangularSelectionTool) |
| PointToInteractiveObject | Transforms a point from the viewer space to the interactive object space. (Inherited from UserInteractionVisualTool) |
| ProcessImeMessages | Processes the IME Windows messages. (Inherited from UserInteractionVisualTool) |
| Reset | Resets this tool. (Inherited from RectangularSelectionTool) |
| ScrollToItem | Scrolls the viewer to the specified item. (Inherited from UserInteractionVisualTool) |
| SetInteractionControllerProperties | Sets properties to the specified interaction controller. (Inherited from UserInteractionVisualTool) |
| TryFinishInteraction | Tries to finish the current interaction. (Inherited from UserInteractionVisualTool) |
Public Events
| Name | Description | |
|---|---|---|
 | Activated | Occurs when the visual tool is activated in the image viewer. (Inherited from VisualTool) |
| Activating | Occurs when the visual tool is activating in the image viewer. (Inherited from VisualTool) |
| ActiveInteractionControllerChanged | Occurs when the ActiveInteractionController property is changed. (Inherited from UserInteractionVisualTool) |
| BuildingFinished | Occurs when the selection building is finished. (Inherited from RectangularSelectionTool) |
| BuildingStarted | Occurs when the selection building is started. (Inherited from RectangularSelectionTool) |
| Deactivated | Occurs when the visual tool is deactivated in the image viewer. (Inherited from VisualTool) |
| Deactivating | Occurs when the visual tool is deactivating in the image viewer. (Inherited from VisualTool) |
| EnabledChanged | Occurs when value of Enabled property is changed. (Inherited from VisualTool) |
| ImageChanged | Occurs when the image is changed. (Inherited from VisualTool) |
| ImageChanging | Occurs when the image is changing. (Inherited from VisualTool) |
| ImageLoadingException | Occurs when the image is not loaded because of error. (Inherited from VisualTool) |
| KeyDown | Occurs when a key is pressed while the image viewer has focus and this tool is enabled. (Inherited from VisualTool) |
| KeyUp | Occurs when a key is released while the image viewer has focus and this tool is enabled. (Inherited from VisualTool) |
| MouseClick | Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is clicked. (Inherited from VisualTool) |
| MouseDoubleClick | Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is double clicked. (Inherited from VisualTool) |
| MouseDown | Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed. (Inherited from VisualTool) |
| MouseEnter | Occurs when the mouse enters an area of visual tool. (Inherited from VisualTool) |
| MouseLeave | Occurs when the mouse leaves an area of visual tool. (Inherited from VisualTool) |
| MouseMove | Occurs when the mouse pointer is moved over the image viewer and this tool is enabled. (Inherited from VisualTool) |
| MouseUp | Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is released. (Inherited from VisualTool) |
| MouseWheel | Occurs when the mouse wheel moves while the image viewer has focus and this tool is enabled. (Inherited from VisualTool) |
| PreviewKeyDown | Occurs before the KeyDown event when a key is pressed while focus is on this visual tool. (Inherited from VisualTool) |
| SelectionChanged | Occurs when the selection (Rectangle) is changed. (Inherited from RectangularSelectionTool) |
See Also