UIGestureRecognizer UIGestureRecognizer Class

Definition

Namespace:
UIKit UIKit
Assembly:
Xamarin.iOS.dll

Base class for gesture recognizers.

[Foundation.Register("UIGestureRecognizer", true)]
public class UIGestureRecognizer : Foundation.NSObject
type UIGestureRecognizer = class
    inherit NSObject
Inheritance
ObjectObject
NSObjectNSObject
UIGestureRecognizerUIGestureRecognizer
Derived
Attributes
RegisterAttribute

Remarks

This abstract base class provides features common to recognizers of touch-oriented user gestures.

Constructors

UIGestureRecognizer() UIGestureRecognizer()

Default constructor that initializes a new instance of this class with no parameters.
UIGestureRecognizer(Action) UIGestureRecognizer(Action)

Initalizes a gesture recognizer.
UIGestureRecognizer(IntPtr) UIGestureRecognizer(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
UIGestureRecognizer(NSObject, Selector) UIGestureRecognizer(NSObject, Selector)

Initializes a designated gesture-recognizer.
UIGestureRecognizer(NSObjectFlag) UIGestureRecognizer(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.
UIGestureRecognizer(Selector, UIGestureRecognizer+Token) UIGestureRecognizer(Selector, UIGestureRecognizer+Token)

Initalizes a gesture recognizer.

Properties

AllowedPressTypes AllowedPressTypes

An array of UIPressType that the gesture recognizer responds to.
AllowedTouchTypes AllowedTouchTypes

An array of UITouchType that the gesture recognizer responds to.
CancelsTouchesInView CancelsTouchesInView

Whether touches recognized as part of a gesture should be delivered to the underlying UIView.
Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.
DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DelaysTouchesBegan DelaysTouchesBegan

Whether this UIGestureRecognizer should delay sending touches to the underlying UIVew during the gesture's begin phase.
DelaysTouchesEnded DelaysTouchesEnded

Whether this UIGestureRecgonizer should delay sending touches to the underlying UIView during the gesture's end phase.
Delegate Delegate

An instance of the UIKit.IUIGestureRecognizerDelegate model class which acts as the class delegate.
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Enabled Enabled

Whether the UIGestureRecognizer is enabled.
Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
Name Name

Gets or set the name of the recognizer.
NumberOfTouches NumberOfTouches

The number of touches involved in the gesture.
RequiresExclusiveTouchType RequiresExclusiveTouchType

Gets or sets whether the UIGestureRecognizer is only considering a single type of touch.
RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
ShouldBegin ShouldBegin

Delegate invoked by the object to get a value.
ShouldBeRequiredToFailBy ShouldBeRequiredToFailBy

Delegate invoked by the object to get a value.
ShouldReceivePress ShouldReceivePress

Delegate invoked by the object to get a value.
ShouldReceiveTouch ShouldReceiveTouch

Delegate invoked by the object to get a value.
ShouldRecognizeSimultaneously ShouldRecognizeSimultaneously

Delegate invoked by the object to get a value.
ShouldRequireFailureOf ShouldRequireFailureOf

Delegate invoked by the object to get a value.
State State

The current state of this UIGestureRecognizer.
Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
View View

The UIView to which this UIGestureRecognizer is attached. Read-only.
WeakDelegate WeakDelegate

An object that can respond to the delegate protocol for this type
Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddTarget(Action) AddTarget(Action)

Registers a new callback for when the gesture has been recognized.
AddTarget(Action<NSObject>) AddTarget(Action<NSObject>)

Registers a new callback for when the gesture has been recognized.
AddTarget(NSObject, Selector) AddTarget(NSObject, Selector)

Low-level version of AddTarget.
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
CanBePreventedByGestureRecognizer(UIGestureRecognizer) CanBePreventedByGestureRecognizer(UIGestureRecognizer)

When overridden, allows the specified UIGestureRecognizer to prevent this UIGestureRecognizer from recognizing a gesture.
CanPreventGestureRecognizer(UIGestureRecognizer) CanPreventGestureRecognizer(UIGestureRecognizer)

When overridden, indicates that this UIGestureRecognizer can prevent the specified UIGestureRecognizer from recognizing a gesture.
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the UIGestureRecognizer object.
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
IgnorePress(UIPress, UIPressesEvent) IgnorePress(UIPress, UIPressesEvent)

Developers may override this method to tell the gesture recognizer to ignore specific presses.
IgnoreTouch(UITouch, UIEvent) IgnoreTouch(UITouch, UIEvent)

Ignores a specific touch of the given event.
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
LocationInView(UIView) LocationInView(UIView)

The PointF in the given UIView of the gesture represented by this UIGestureRecognizer.
LocationOfTouch(nint, UIView) LocationOfTouch(nint, UIView)

Gets the location, in the coordinate system of , of one of the touches in the gesture.
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
PressesBegan(NSSet<UIPress>, UIPressesEvent) PressesBegan(NSSet<UIPress>, UIPressesEvent)

Indicates that a physical button has been pressed on a remote or game controller.
PressesCancelled(NSSet<UIPress>, UIPressesEvent) PressesCancelled(NSSet<UIPress>, UIPressesEvent)

Indicates a physical button-press event has been cancelled due to a system event.
PressesChanged(NSSet<UIPress>, UIPressesEvent) PressesChanged(NSSet<UIPress>, UIPressesEvent)

Indicates that the Force value of the evt has changed.
PressesEnded(NSSet<UIPress>, UIPressesEvent) PressesEnded(NSSet<UIPress>, UIPressesEvent)

Indicates the ending of a press of a physical button on a remote or game controller.
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveTarget(NSObject, Selector) RemoveTarget(NSObject, Selector)

Low-level counterpart to the low-level AddTarget method.
RemoveTarget(UIGestureRecognizer+Token) RemoveTarget(UIGestureRecognizer+Token)

Removes the callback method for the specified gesture being recognized, based on the token that was returned by AddTarget.
RequireGestureRecognizerToFail(UIGestureRecognizer) RequireGestureRecognizerToFail(UIGestureRecognizer)

Causes this UIGestureRecognizer to only work if the specified UIGestureRecognizer fails (e.g., a single-tap gesture might require that a double-tap gesture fail).
Reset() Reset()

When overridden, allows the application developer to reset internal state when a gesture is recognized.
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ShouldBeRequiredToFailByGestureRecognizer(UIGestureRecognizer) ShouldBeRequiredToFailByGestureRecognizer(UIGestureRecognizer)

Specifically overridden to indicate that a receiver requires the specified gesture recognizer to fail.
ShouldRequireFailureOfGestureRecognizer(UIGestureRecognizer) ShouldRequireFailureOfGestureRecognizer(UIGestureRecognizer)

Returns a value that tells whether the receiver requires otherGestureRecognizer to fail.
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
TouchesBegan(NSSet, UIEvent) TouchesBegan(NSSet, UIEvent)

Indicates that one or more fingers have touched down in the associated UIView.
TouchesCancelled(NSSet, UIEvent) TouchesCancelled(NSSet, UIEvent)

Indicates that a system event (e.g., a low-memory warning) has cancelled the touch event.
TouchesEnded(NSSet, UIEvent) TouchesEnded(NSSet, UIEvent)

Indicates that one or more fingers have lifted in the associated UIView.
TouchesEstimatedPropertiesUpdated(NSSet) TouchesEstimatedPropertiesUpdated(NSSet)

Called when the estimated properties of touches have been updated.
TouchesMoved(NSSet, UIEvent) TouchesMoved(NSSet, UIEvent)

Indicates that one or more fingers have moved in the associated UIView.
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also