SwipeGestureRecognizer Class
Definition
A gesture recognizer that detects swipe gestures and raises Avalonia.Input.InputElement.SwipeGestureEvent on the target element when a swipe is confirmed.
public class SwipeGestureRecognizer
Constructors
| Name | Description |
|---|---|
| SwipeGestureRecognizer | No summary available. |
SwipeGestureRecognizer Constructor
public SwipeGestureRecognizer()
Methods
| Name | Description |
|---|---|
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| BeginInit | Inherited from StyledElement. |
| EndInit | Inherited from StyledElement. |
| TryGetResource | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Properties
| Name | Description |
|---|---|
| CrossAxisCancelThreshold | Gets or sets the maximum cross-axis drift in pixels allowed before the gesture is cancelled. Default is 8px. |
| EdgeSize | Gets or sets the leading-edge start zone in pixels. When greater than zero, tracking only begins if the pointer is within this distance of the leading edge. Default is 0 (full area). |
| IsEnabled | Gets or sets a value indicating whether the recognizer responds to pointer events. Setting this to false is a lightweight alternative to removing the recognizer from the collection. Default is true. |
| Threshold | Gets or sets the minimum distance in pixels the pointer must travel before a swipe is recognized. Default is 30px. |
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| Theme | Gets or sets the theme to be applied to the element. Inherited from StyledElement. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
CrossAxisCancelThreshold Property
Gets or sets the maximum cross-axis drift in pixels allowed before the gesture is cancelled. Default is 8px.
public double CrossAxisCancelThreshold { get; set; }
EdgeSize Property
Gets or sets the leading-edge start zone in pixels. When greater than zero, tracking only begins if the pointer is within this distance of the leading edge. Default is 0 (full area).
public double EdgeSize { get; set; }
IsEnabled Property
Gets or sets a value indicating whether the recognizer responds to pointer events. Setting this to false is a lightweight alternative to removing the recognizer from the collection. Default is true.
public bool IsEnabled { get; set; }
Threshold Property
Gets or sets the minimum distance in pixels the pointer must travel before a swipe is recognized. Default is 30px.
public double Threshold { get; set; }
Fields
CrossAxisCancelThresholdProperty Field
Defines the Avalonia.Input.GestureRecognizers.SwipeGestureRecognizer.CrossAxisCancelThreshold property.
public Avalonia.StyledProperty<TValue><double> CrossAxisCancelThresholdProperty
EdgeSizeProperty Field
Defines the Avalonia.Input.GestureRecognizers.SwipeGestureRecognizer.EdgeSize property. Leading-edge start zone in px. 0 (default) = full area. When > 0, only starts tracking if the pointer is within this many px of the leading edge (LTR: left; RTL: right).
public Avalonia.StyledProperty<TValue><double> EdgeSizeProperty
IsEnabledProperty Field
Defines the Avalonia.Input.GestureRecognizers.SwipeGestureRecognizer.IsEnabled property. When false, the recognizer ignores all pointer events. Lets callers toggle the recognizer at runtime without needing to remove it from the collection (GestureRecognizerCollection has Add but no Remove). Default: true.
public Avalonia.StyledProperty<TValue><bool> IsEnabledProperty
ThresholdProperty Field
Defines the Avalonia.Input.GestureRecognizers.SwipeGestureRecognizer.Threshold property.
public Avalonia.StyledProperty<TValue><double> ThresholdProperty
Events
| Name | Description |
|---|---|
| ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement. |
| AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |