isCanceled Property

Summary

Indicates if this drag operation was canceled.

Syntax

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

Property Value

true if this drag operation was canceled, otherwise; false.

Remarks

A drag operation consists of DragStarted (when the user clicks the mouse or touch down), followed by one or more DragDelta (while dragging on the control) and finally DragCompleted (when the mouse is released or touch up). This drag operation can be aborted at anytime if one of the following occur after DragStarted has been fired but before DragCompleted:

  • The user has switched the UI away from the control. For example by pressing ALT-TAB or the Windows key in platforms that support a keyboard.

  • The user has pressed the Escape key and the value of InteractiveService.CancelOnEscape was set to true.

In these cases, the service will fire the DragCompleted to complete the drag operation but the value of IsCanceled will be set to true and ImageViewerInteractiveMode objects listening to the drag event will abort the work started.

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