| Name | Description | |
|---|---|---|
 | WebAnnotationVisualToolJS | Initializes a new instance of the WebAnnotationVisualToolJS class. |
WebAnnotationVisualToolJS Class Members
In This Topic
The following tables list the members exposed by WebAnnotationVisualToolJS.
Public Constructors
Methods
| Name | Description | |
|---|---|---|
 | addAndBuildAnnotation | Adds annotation to the annotation collection of focused image and starts building of annotation. |
| cancelAnnotationBuilding | Cancels building of annotation. |
| findAnnotationView | Finds an annotation view at specified point, in the coordinate space of HTML document. |
| get_ActionButton | Gets the mouse button, which executes the action of the visual tool. (Inherited from WebVisualToolJS) |
| get_ActionCursor | Gets a cursor which should be used in image viewer when visual tool executes its action. (Inherited from WebVisualToolJS) |
| get_AnnotationBoundingRect | Gets a rectangle, in image space, in device-independent pixels (1/96th inch), that restricts the area of image where annotation can be built. |
| get_AnnotationInteractionMode | Gets the interaction mode that defines how user can interact with annotations. |
| get_AnnotationViewCollection | Gets an annotation collection that will be viewed and edited using the visual tool. |
| get_Cursor | Gets a cursor which should be used in image viewer when visual tool is active in image viewer. (Inherited from WebVisualToolJS) |
| get_DisableContextMenu | Gets 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 WebVisualToolJS) |
| get_FocusedAnnotationView | Gets the focused annotation view. |
| get_IsAnnotationBoundingRectEnabled | Gets a value indicating whether the annotation can be built only in specified region. |
| get_IsEnabled | Gets a value indicating whether visual tool can respond to the user interaction. (Inherited from WebVisualToolJS) |
| get_IsMultipageModeSupported | Gets a value indicating whether this tool supports multipage mode. |
| get_MouseClickCount | Gets the count of mouse clicks in series of clicks. (Inherited from WebVisualToolJS) |
| get_MouseClicksDelta | Gets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from WebVisualToolJS) |
| get_Name | Gets the name of visual tool. (Inherited from WebVisualToolJS) |
| get_RaiseAnnotationEventsInAuthorMode | Gets a value indicating whether the annotation visual tool should raise annotation events ("hoveredAnnotationChanged" event) in WebAnnotationInteractionModeEnumJS.Author mode. |
| get_RaiseAnnotationEventsInViewMode | Gets a value indicating whether the annotation visual tool should raise annotation events ("hoveredAnnotationChanged" event) in WebAnnotationInteractionModeEnumJS.View mode. |
| getDrawingBox | Returns the drawing box of visual tool. |
| reset | Resets the visual tool. (Inherited from WebVisualToolJS) |
| set_ActionButton | Sets the mouse button, which executes the action of the visual tool. (Inherited from WebVisualToolJS) |
| set_ActionCursor | Sets a cursor which should be used in image viewer when visual tool executes its action. (Inherited from WebVisualToolJS) |
| set_AnnotationBoundingRect | Gets a rectangle, in image space, in device-independent pixels (1/96th inch), that restricts the area of image where annotation can be built. |
| set_AnnotationInteractionMode | Sets the interaction mode that defines how user can interact with annotations. |
| set_AnnotationViewCollection | Sets an annotation collection that will be viewed and edited using the visual tool. |
| set_Cursor | Sets a cursor which should be used in image viewer when visual tool is active in image viewer. (Inherited from WebVisualToolJS) |
| set_DisableContextMenu | 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 WebVisualToolJS) |
| set_FocusedAnnotationView | Sets the focused annotation view. |
| set_IsAnnotationBoundingRectEnabled | Sets a value indicating whether the annotation can be built only in specified region. |
| set_IsEnabled | Sets a value indicating whether visual tool can respond to user interaction. |
| set_MouseClicksDelta | Sets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from WebVisualToolJS) |
| set_RaiseAnnotationEventsInAuthorMode | Sets a value indicating whether the annotation visual tool should raise annotation events ("hoveredAnnotationChanged" event) in WebAnnotationInteractionModeEnumJS.Author mode. |
| set_RaiseAnnotationEventsInViewMode | Sets a value indicating whether the annotation visual tool should raise annotation events ("hoveredAnnotationChanged" event) in WebAnnotationInteractionModeEnumJS.View mode. |
| setFocusedAnnotationView | Sets the focused annotation view specified by index. |
| toString | Returns the string representation of this object. (Inherited from WebVisualToolJS) |
Events
| Name | Description | |
|---|---|---|
 | activated | Occurs when the visual tool is activated in the image viewer. (Inherited from WebVisualToolJS) |
| annotationBuildingCanceled | Occurs when annotation building is canceled. |
| annotationBuildingFinished | Occurs when annotation building is finished. |
| annotationBuildingStarted | Occurs when annotation building is started. |
| annotationInteractionModeChanged | Occurs when annotation interaction mode is changed. |
| annotationTransformingFinished | Occurs when annotation transforming is finished. |
| annotationTransformingStarted | Occurs when annotation transforming is started. |
| deactivated | Occurs when the visual tool is deactivated in the image viewer. (Inherited from WebVisualToolJS) |
| focusedAnnotationChanged | Occurs when focused annotation in visual tool is changed. |
| focusedAnnotationCollectionChanged | Occurs when focused annotation collection is changed. |
| hoveredAnnotationChanged | Occurs when hovered annotation is changed and the annotation interaction mode is set to "View". |
| initializationException | Occurs when the visual tool initialization is failed. (Inherited from WebVisualToolJS) |
| initializationFinished | Occurs when the visual tool initialization is finished. (Inherited from WebVisualToolJS) |
| initializationStarted | Occurs when the visual tool initialization is started. (Inherited from WebVisualToolJS) |
| mouseDoubleClick | Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is double clicked. (Inherited from WebVisualToolJS) |
| mouseDown | Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed. (Inherited from WebVisualToolJS) |
| mouseMove | Occurs when the mouse pointer is moved and this tool is enabled. (Inherited from WebVisualToolJS) |
| mouseUp | Occurs when this tool is enabled and a mouse button is released. (Inherited from WebVisualToolJS) |
See Also