VisualTool Class Members

In This Topic

The following tables list the members exposed by VisualTool.

Protected Constructors

	Name	Description
	VisualTool	Initializes a new instance of the VisualTool class.

Public Properties

	Name	Description
	ActionButton	Gets or sets the mouse button, which executes the action of this tool.
	ActionCursor	Gets or sets a cursor, which should be used in image viewer when visual tool executes its action.
	AllowNextItemSelection	Gets or sets a value indicating whether the tool allows changing focused item using the PerformNextItemSelection(Boolean) method.
	CanModifyImage	Gets a value indicating whether this visual tool can modify the image.
	Cursor	Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer.
	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.
	Enabled	Gets or sets a value indicating whether VisualTool can respond to the user interaction.
	ImageViewer	Gets the ImageViewer object associated with this tool.
	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.
	Name	Gets the name of visual tool.
	SelectNextItemKeyCode	Gets or sets a key code that changes the selected item to the next item.
	SelectPrevItemKeyCode	Gets or sets a key code that changes the selected item to the previous item.

Protected Properties

	Name	Description
	EnableViewerInvalidate	Gets or sets a value indicating whether viewer must be invalidated when InvalidateViewer method is executed.
	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.
	MouseClickCount	Gets the count of mouse clicks in series of clicks.
	MouseClicksDelta	Gets or sets a delay, in milliseconds, between mouse clicks in series of clicks.

Public Methods

	Name	Description
	Dispose	Overloaded. Releases all resources used by the object.
	FindVisualTool<T>	Finds the specified visual tool of specified type in visual tool.
	PerformNextItemSelection	Selects the next available item and makes it as the active item.
	ToString	Returns the string representation of this object.

Protected Methods

	Name	Description
	InvalidateViewer	Overloaded. Invalidates the specified region of the , and causes a paint message to be sent to the .
	Invoke	Overloaded. Executes the specified delegate on the thread that owns the 's underlying .
	IsActionButtonContains	Determines whether the ActionButton contains the button.
	NeedProcessMouseEvent	Returns a value indicating whether the visual tool will process the mouse event.
	OnActivated	Raises the Activated event.
	OnActivating	Raises the Activating event.
	OnDeactivated	Raises the Deactivated event.
	OnDeactivating	Raises the Deactivating event.
	OnEnabledChanged	Raises the EnabledChanged event.
	OnImageChanged	Raises the ImageChanged event.
	OnImageChanging	Raises the ImageChanging event.
	OnImageLoadingException	Raises the ImageLoadingException event.
	OnKeyDown	Raises the KeyDown event.
	OnKeyUp	Raises the KeyUp event.
	OnLostFocus	Occurs when visual tool loses the focus.
	OnMouseClick	Raises the MouseClick event.
	OnMouseDoubleClick	Raises the MouseDoubleClick event.
	OnMouseDown	Raises the MouseDown event.
	OnMouseEnter	Raises the MouseEnter event.
	OnMouseLeave	Raises the MouseLeave event.
	OnMouseMove	Raises the MouseMove event.
	OnMouseUp	Raises the MouseUp event.
	OnMouseWheel	Raises the MouseWheel event.
	OnPaint	Overloaded. Paints content of visual tool on specified image.
	OnPreviewKeyDown	Raises the PreviewKeyDown event.
	ProcessImeMessages	Processes the IME Windows messages.
	Reset	Resets this tool.

Public Events

	Name	Description
	Activated	Occurs when the visual tool is activated in the image viewer.
	Activating	Occurs when the visual tool is activating in the image viewer.
	Deactivated	Occurs when the visual tool is deactivated in the image viewer.
	Deactivating	Occurs when the visual tool is deactivating in the image viewer.
	EnabledChanged	Occurs when value of Enabled property is changed.
	ImageChanged	Occurs when the image is changed.
	ImageChanging	Occurs when the image is changing.
	ImageLoadingException	Occurs when the image is not loaded because of error.
	KeyDown	Occurs when a key is pressed while the image viewer has focus and this tool is enabled.
	KeyUp	Occurs when a key is released while the image viewer has focus and this tool is enabled.
	MouseClick	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is clicked.
	MouseDoubleClick	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is double clicked.
	MouseDown	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed.
	MouseEnter	Occurs when the mouse enters an area of visual tool.
	MouseLeave	Occurs when the mouse leaves an area of visual tool.
	MouseMove	Occurs when the mouse pointer is moved over the image viewer and this tool is enabled.
	MouseUp	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is released.
	MouseWheel	Occurs when the mouse wheel moves while the image viewer has focus and this tool is enabled.
	PreviewKeyDown	Occurs before the KeyDown event when a key is pressed while focus is on this visual tool.

Reference

VisualTool Class
Vintasoft.Imaging.UI.VisualTools Namespace

Send Feedback