idleCursor Property

Summary

Mouse cursor to use for the idle state of this ImageViewerInteractiveMode

Syntax
TypeScript
JavaScript
Object.defineProperty(ImageViewerInteractiveMode.prototype, 'idleCursor', 
	get: function(), 
	set: function(value) 
) 
idleCursor: string;

Property Value

The mouse cursor to use for the idle state of this ImageViewerInteractiveMode. The default value is null.

Remarks

IdleCursor and WorkingCursor are only used when this ImageViewerInteractiveMode is attached to the left mouse button and is enabled. It will not be used if this mode is attached to any other button or to touch. Mouse cursors are only supported by desktop browsers.

The values are standard HTML cursor strings. You can use a value like "crosshair" or "move". They will be set into the CSS style.cursor property of the HTML element. A value of null, means "do not change the cursor".

The cursors are set into the ImageViewer main div (ImageViewer.MainDiv) and foreground canvas (ImageViewer.ForeCanvas) elements when this interactive mode is assigned to the left mouse button. Also, the cursors will be set in any elements added by the user to the InteractiveService.UserControls collection.

IdleCursor will be set when the interactive mode is started (after Start is called) and removed when the mode is stopped (when Stop is called).

WorkingCursor will be set when the interactive mode is working (When OnWorkStarted is called) and removed (or set back to idle) when the interactive mode has stopped working (When OnWorkCompleted) is called).

These cursors can be used to provide a visual clue into the current interactive mode operations. For instance, when using the ImageViewerPanZoomInteractiveMode interactive mode, you can set IdleCursor to "crosshair" and WorkingCursor to "move".

Example

For an example, refer to WorkingCursor.

Requirements

Target Platforms

Help Version 20.0.2020.4.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly
Introduction
Getting Started
Namespaces
Leadtools.Controls Namespace
Assemblies