| Name | Description | |
|---|---|---|
 | AnnotationVisualTool | Initializes a new instance of the AnnotationVisualTool class. |
AnnotationVisualTool Class Members
In This Topic
The following tables list the members exposed by AnnotationVisualTool.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | ActionButton | Gets or sets the mouse button, which executes the action of this tool. (Inherited from UserInteractionVisualTool) |
| 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) |
| AllowMoveSelectedAnnotations | Gets or sets a value indicating whether the annotation viewer allows to move selected annotations together. |
| AllowNextItemSelection | Gets or sets a value indicating whether the tool allows changing focused item using the PerformNextItemSelection(Boolean) method. (Inherited from VisualTool) |
| AnnotationBoundingRect | Gets or sets a System.Drawing.Rectangle, in image space, in device-independent pixels (1/96th inch), that restricts the area of image where annotation can be built. |
| AnnotationInteractionMode | Gets or sets the interaction mode of annotations. |
| AnnotationSelectionBrush | Gets or sets the System.Drawing.Brush that is used to fill the selection of selected annotations. |
| AnnotationSelectionPen | Gets or sets the System.Drawing.Pen that is used to draw the selecion of selected annotations. |
| AnnotationViewCollection | Gets or sets an annotation collection that will be viewed and edited using the visual tool. |
| CanModifyImage | Gets a value indicating whether this visual tool can modify the image. (Inherited from VisualTool) |
| 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. |
 | ClipboardAnnotationDataFormat | Gets the data format for annotations in clipboard. |
| CopyAction | Gets the UI action that copies the selected annotations to the clipboard. |
| Cursor | Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool) |
| CutAction | Gets the UI action that cuts the selected annotations to the clipboard. |
| DeleteAction | Gets the UI action that deletes the selected annotations. |
| DeleteAllAction | Gets the UI action that deletes all annotations. |
| DeselectAllAction | Gets the UI action that deselects all annotations. |
| 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) |
| Enabled | Gets or sets a value indicating whether VisualTool can respond to the user interaction. (Inherited from VisualTool) |
| FocusedAnnotationView | Gets or sets the focused annotation view. |
| HoveredAnnotationView | Gets the hovered annotation view. |
| ImageViewer | Gets the ImageViewer object associated with this tool. (Inherited from VisualTool) |
| IsAnnotationBoundingRectEnabled | Gets or sets a value indicating whether the annotation can be built only in specified region. |
| IsFinishInteractionOnLostFocus | Gets or sets a value indicating whether interaction should be finished when focus is lost. (Inherited from UserInteractionVisualTool) |
| IsFocusedAnnotationBuilding | Gets a value indicating whether focused annotation is building. |
| IsMultipageModeSupported | Gets a value indicating whether this tool supports multipage mode. |
| IsVisibleWithoutImage | Gets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from VisualTool) |
| MultiSelect | Gets or sets a value indicating whether the annotation viewer allows multiple selection of annotations. |
| Name | Gets the name of visual tool. |
| PasteAction | Gets the UI action that pastes the selected annotations from the clipboard. |
| RaiseAnnotationEventsInAuthorMode | Gets or sets a value indicating whether the annotation visual tool should raise annotation events in AnnotationInteractionMode.Author mode. |
| RaiseAnnotationEventsInViewMode | Gets or sets a value indicating whether the annotation visual tool should raise annotation events in AnnotationInteractionMode.View mode. |
| RotationAssistant | Gets the rotation assistant used for rotation of selected annotation. |
| RotationPoint | Gets or sets the rotation point. |
| RotationPointDistance | Gets or sets a distance from the annotation bounding box to the rotation point, in pixels. |
| SelectAllAction | Gets the UI action that selects all annotations. |
| SelectedAnnotations | Gets the collection that contains selected annotations. |
| 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) |
| SpellChecker | Gets or sets the spell check manager that is used for spell checking of text in text annotations. |
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. |
| 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) |
| UseActionButtonToInteractionController | Gets a value indicating whether interaction controller should use ActionButton of visual tool. |
Public Methods
| Name | Description | |
|---|---|---|
 | AddAndBuildAnnotation | Overloaded. Adds annotation to the annotation collection of focused image and starts building of annotation. |
| CancelActiveInteraction | Cancels an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool) |
| CancelAnnotationBuilding | Cancels building of annotation. |
| CreateAnnotationViewCollection | Creates the annotation view collection for specified image. |
| Dispose | Overloaded. Releases all resources used by the |
| FindAnnotationView | Finds an annotation view at specified point, in the image viewer space. |
| 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) |
| FinishAnnotationBuilding | Finishes building of annotation. |
| GetActiveInteractionController | Overloaded. Returns the active interaction controller of specified visual tool. (Inherited from UserInteractionVisualTool) |
| GetSelectableAnnotations | Returns the annotation collection that must be selected. |
| GetSupportedUIActions | Returns the supported UI actions. |
| InvalidateFocusedItem | Invalidates a drawing box of focused interactive object. (Inherited from UserInteractionVisualTool) |
| InvalidateItem | Invalidates a drawing box of specified interactive object. (Inherited from UserInteractionVisualTool) |
| IsPointOnInteractionArea | Determines that the specified point is located on interaction area. |
| PerformNextItemSelection | Selects the next available item and makes it as the active item. |
| ScrollToFocusedItem | Scrolls the viewer to the focused item. (Inherited from UserInteractionVisualTool) |
| SetFocusedAnnotationView | Sets the annotation view that associated with specified annotation data as focused annotation view. |
| ToString | Returns the string representation of this object. (Inherited from VisualTool) |
Protected Methods
| Name | Description | |
|---|---|---|
 | BeginInteraction | Begins an active interaction. |
| CanChangeFocusedItem | Determines that focused item can be changed. |
| CanSelectNextItem | Returns a value indicating whether next item can be selected. |
| CheckIsPointOnUnfocusedImage | Returns a value indicating whether the point is located on unfocused image. (Inherited from UserInteractionVisualTool) |
| CreateCopyUIAction | Creates the UI action that copies the selected annotations to the clipboard. |
| CreateCutUIAction | Creates the UI action that cuts the selected annotations to the clipboard. |
| CreateDeleteAllUIAction | Creates the UI action that deletes all annotations. |
| CreateDeleteUIAction | Creates the UI action that deletes the selected annotations. |
| CreateDeselectAllUIAction | Creates the UI action that deselects all annotations. |
| CreatePasteUIAction | Creates the UI action that pastes the selected annotations from the clipboard. |
| CreateSelectAllUIAction | Creates the UI action that selects all annotations. |
| DrawItem | Draws an interactive object on specified graphics. |
| 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. |
| FinishInteraction | Finishes an active interaction. |
| 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 UserInteractionVisualTool) |
| OnActivating | Raises the Activating event. (Inherited from VisualTool) |
| OnActiveInteractionControllerChanged | Occurs when active interaction controller is changed. |
| OnAnnotationBuildingCanceled | Raises the AnnotationBuildingCanceled event. |
| OnAnnotationBuildingCanceling | Raises the AnnotationBuildingCanceling event. |
| OnAnnotationBuildingFinished | Raises the AnnotationBuildingFinished event. |
| OnAnnotationBuildingStarted | Raises the AnnotationBuildingStarted event. |
| OnAnnotationBuildingStarting | Raises the AnnotationBuildingStarting event. |
| OnAnnotationDrawException | Raises the AnnotationDrawException event. |
| OnAnnotationInteractionModeChanged | Raises the AnnotationInteractionModeChanged event. |
| OnAnnotationInteractionModeChanging | Raises the AnnotationInteractionModeChanging event. |
| OnAnnotationTransformingFinished | Raises the AnnotationTransformingFinished event. |
| OnAnnotationTransformingStarted | Raises the AnnotationTransformingStarted event. |
| OnAnnotationViewCollectionChanged | Raises the AnnotationViewCollectionChanged event. |
| OnDeactivated | Raises the Deactivated event. (Inherited from UserInteractionVisualTool) |
| OnDeactivating | Raises the Deactivating event. (Inherited from VisualTool) |
| OnEnabledChanged | Raises the EnabledChanged event. (Inherited from VisualTool) |
| OnFocusedAnnotationViewChanged | Raises the FocusedAnnotationViewChanged event. |
| OnFocusedAnnotationViewChanging | Raises the FocusedAnnotationViewChanging event. |
| OnFocusedItemChanged | Occurs when focused item is changed. |
| OnFocusedItemChanging | Occurs when focused item is changing. |
| OnHoveredAnnotationViewChanged | Raises the HoveredAnnotationViewChanged event. |
| OnHoveredAnnotationViewChanging | Raises the HoveredAnnotationViewChanging event. |
| 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 interaction event for specified interactive object. |
| 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. (Inherited from UserInteractionVisualTool) |
| OnKeyUp | Raises the KeyUp event. (Inherited from UserInteractionVisualTool) |
| OnLostFocus | Occurs when visual tool loses the focus. (Inherited from UserInteractionVisualTool) |
| OnMouseClick | Raises the MouseClick event. |
| OnMouseDoubleClick | Raises the MouseDoubleClick event. |
| OnMouseDown | Raises the MouseDown event. |
| OnMouseEnter | Raises the MouseEnter event. (Inherited from VisualTool) |
| OnMouseLeave | Raises the MouseLeave event. (Inherited from VisualTool) |
| OnMouseMove | Raises the MouseMove event. |
| OnMouseUp | Raises the MouseUp event. |
| OnMouseWheel | Raises the MouseWheel event. |
| OnPaint | Overloaded. Paints content of visual tool. (Inherited from UserInteractionVisualTool) |
| OnPreviewKeyDown | Raises the PreviewKeyDown event. (Inherited from VisualTool) |
| 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 VisualTool) |
| ScrollToItem | Scrolls the viewer to the specified item. (Inherited from UserInteractionVisualTool) |
| SetInteractionControllerProperties | Sets properties to the specified interaction controller. |
| 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) |
| AnnotationBuildingCanceled | Occurs when the annotation building is canceled. |
| AnnotationBuildingCanceling | Occurs when the annotation building is canceling. |
| AnnotationBuildingFinished | Occurs when the annotation building is finished. |
| AnnotationBuildingStarted | Occurs when the annotation building is started. |
| AnnotationBuildingStarting | Occurs when the annotation building is starting. |
| AnnotationDrawException | Occurs when the annotation is not drawn because of error. |
| AnnotationInteractionModeChanged | Occurs when the annotation interaction mode is changed. |
| AnnotationInteractionModeChanging | Occurs when the annotation interaction mode is changing. |
| AnnotationTransformingFinished | Occurs when the annotation transforming is finished. |
| AnnotationTransformingStarted | Occurs when the annotation transforming is started. |
| AnnotationViewCollectionChanged | Occurs when the AnnotationViewCollection property is changed. |
| 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) |
| FocusedAnnotationViewChanged | Occurs when the FocusedAnnotationView is changed. |
| FocusedAnnotationViewChanging | Occurs when the FocusedAnnotationView is changing. |
| HoveredAnnotationViewChanged | Occurs when the HoveredAnnotationView is changed. |
| HoveredAnnotationViewChanging | Occurs when the HoveredAnnotationView is changing. |
| 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) |
See Also