TextEdit.Spin Event

Occurs when either the UP or DOWN ARROW key is pressed or the mouse wheel is rotated.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

[DXCategory("Events")]
public event SpinEventHandler Spin
<DXCategory("Events")>
Public Event Spin As SpinEventHandler

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 whether the event has been handled, and no default processing is required.
IsSpinUp A Boolean value that specifies whether the Up Arrow key or Up Spin button (in a SpinEdit control) has been pressed, or the mouse wheel has been rotated up.

Remarks

This event occurs when an end-user presses the UP or DOWN ARROW keys or the mouse wheel is rotated. It 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 is left set to false, the current end-user action will be processed by the editor.

The editor's Spin event is equivalent to the RepositoryItemTextEdit.Spin event available via the TextEdit.Properties object, i.e., adding/removing an event handler for the current event actually affects the RepositoryItemTextEdit.Spin event.

NOTE

The Spin event is not raised by look up editors (LookUpEditBase descendants). To respond to mouse wheel rotation for these editors, handle the RepositoryItem.MouseWheel event. To respond to a key press, handle the RepositoryItem.KeyDown event.

NOTE

The Spin event is not raised by ComboBoxEdit and its descendants when the UP or DOWN ARROW keys are pressed (the event is only fired in response to mouse wheel rotation).

See Also