isCanceled Property (InteractivePinchCompletedEventArgs)

Summary

Indicates if this pinch operation was canceled.

Syntax

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

Property Value

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

Remarks

A pinch operation consists of PinchStarted (when the user touch down with two fingers), followed by one or more PinchDelta (while dragging on the control) and finally PinchCompleted (when the fingers are moved up). This pinch operation can be aborted at anytime if one of the following occur after PinchStarted has been fired but before PinchCompleted:

  • 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 PinchCompleted to complete the pinch operation but the value of IsCanceled will be set to true and ImageViewerInteractiveMode objects listening to the pinch event will abort the work started.

Requirements

Target Platforms

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
Leadtools.Controls Assembly
Click or drag to resize