getMouseShape()

Description

Gets the shape of the mouse (cursor) hovering over the image container.

Syntax

ImageViewerObject.ui.getMouseShape();

Return value

bool

If it fails to get the mouse shape, it returns null.

Remarks

The default return value is false.
When the method returns true, the cursor is set as a hand.
If the width or height of the image is bigger than the Dynamsoft image viewer, scroll bars will appear and you can drag the image to adjust the position.

When the method returns false, the cursor is set as a cross.

Please note that no matter whether it’s set to true or false, the cursor is an arrow as long as the cursor is outside of image container.

When an error occurs, check getErrorCode() or getErrorString() for error information.

Example

             var imageviewer = DCSObject.getImageViewer ("ImageViewerContainer");  // Get a specified image viewer
             imageviewer.ui.setMouseShape(true);
             imageviewer.ui.getMouseShape();
       

See also

.ui.setMouseShape()
.ui.setImageViewMode()
.ui.onimageareaselected
.ui.onimageareadeselected