| Name | Description | |
|---|---|---|
 | WebHighlightToolJS | Initializes a new instance of the WebHighlightToolJS class. |
WebHighlightToolJS Class Members
In This Topic
The following tables list the members exposed by WebHighlightToolJS.
Public Constructors
Methods
| Name | Description | |
|---|---|---|
 | addItems | Adds the image regions that should be highlighted in the image viewer |
| clearItems | Clears all highlighted image regions from the highlight tool. |
| findItem | Finds the highlighted image region located at the specified coordinates. |
| 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_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_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. (Inherited from WebVisualToolJS) |
| 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_SelectedItem | Gets the highlighted image region which is selected in the image viewer. |
| get_SelectedItemBrushColor | Gets a color of brush that should be used for filling the highlighted image region in the image viewer. |
| get_SelectedItemPenColor | Gets a color of pen that should be used for drawing the outline of the highlighted image region in the image viewer. |
| getDrawingBox | Gets the drawing box of visual tool. |
| removeItemAt | Removes the highlighted image region from the highlight tool. |
| reset | Resets the visual tool. |
| selectItem | Selects the specified image region. |
| 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_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_IsEnabled | Sets a value indicating whether visual tool can respond to the user interaction. (Inherited from WebVisualToolJS) |
| set_MouseClicksDelta | Sets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from WebVisualToolJS) |
| set_SelectedItem | Sets the highlighted image region that should be selected in the image viewer. |
| set_SelectedItemBrushColor | Sets a color of brush that should be used for filling the highlighted image region in the image viewer. |
| set_SelectedItemPenColor | Sets a color of pen that should be used for drawing the outline of the highlighted image region in the image viewer. |
| 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) |
| deactivated | Occurs when the visual tool is deactivated in the image viewer. (Inherited from WebVisualToolJS) |
| 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