TextEdit.Spin Event
Occurs when the UP or DOWN ARROW key is pressed, or the mouse wheel is rotated.
Namespace: DevExpress.Xpf.Editors
Assembly: DevExpress.Xpf.Core.v20.2.dll
NuGet Packages: DevExpress.WindowsDesktop.Wpf.Core, DevExpress.Wpf.Core
Declaration
Event Data
The Spin event's data class is SpinEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Handled | Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs. |
| IsSpinUp | Gets or sets whether the edit value has been increased. |
| OriginalSource | Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs. |
| RoutedEvent | Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs. |
| Source | Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| InvokeEventHandler(Delegate, Object) | When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs. |
| OnSetSource(Object) | When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs. |
Remarks
The Spin event occurs when an end user presses the UP or DOWN ARROW keys, scrolls the mouse wheel, or when the TextEdit.SpinUp or TextEdit.SpinDown method is called. The Spin event can be handled to increase or decrease the editor’s value in a custom manner.
Set the Handled parameter to true to indicate that the event has been handled and no default processing is required. If the Handled parameter remains set to false, the current end-user action will be processed by the editor.
Use the event parameter’s IsSpinUp property to obtain whether the editor has been spun up or down.