isHandled Property

Summary

Indicates whether this event is handled.

Syntax

JavaScript Syntax
Object.defineProperty(InteractiveEventArgs.prototype, 'isHandled', 
	get: function(), 
	set: function(value) 
) 
TypeScript Syntax
isHandled: boolean; 

Property Value

true if this event is handled; otherwise, false. The default value is false.

Remarks

The isHandled property is used by the ImageViewerInteractiveMode object to indicate that a mode has handled the event. Disregarding the value of this property or not setting it to true can allow multiple enabled modes to respond to a single interactive event.

Typically, in order to determine that an interactive mode should try to respond to an event, ImageViewerInteractiveMode.canStartWork is called. This method will return false if isHandled is already true. If the method returns false, the mode should take no action; however, some interactive modes are designed to work regardless of the value of isHandled or the result of ImageViewerInteractiveMode.canStartWork.

For more information, refer to Image Viewer Interactive Modes.

Requirements

Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly