cancelOnEscape Property

Summary

Indicates whether to cancel current operation when the user hits the ESC key on the keyboard.

Syntax

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

Property Value

true to cancel current operation when the user hits the ESC key on the keyboard, otherwise; false. Default value is true.

Remarks

When the value of CancelOnEscape is true (the default value). The service will cancel any operation if the user hits the ESC key on the keyboard (if supported). For example, if the user clicks the mouse or touches down a drag operation will occur. DragStarted and then one or more DragDelta will occur as the user drags on the control. If the user then hits the ESC key on the keyboard before releasing the mouse or touch, then the service will cancel this drag operation by immediately sending a DragCompleted event with the value of IsCanceled set to true. You must check for this value to cancel the operation as well.

Cancelation will also occur if the platform supports notifications when the control loses the focus.

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