SpinEdit

Inheritance Hierarchy

          IComponent

          IControl

          ICustomEdit

          IEditBox

          IEditBoxEx

          ISpinEdit

          SpinEdit

Description

The SpinEdit component is the combination of single-line editing field and changing value buttons.

Working with the Component

It allows to display and edit different data (text and numeric). As opposed to the other editors (FloatEdit, IntegerEdit), which change the value by the required step, in the SpinEdit component the step and the resulting value are defined by the user algorithm. This algorithm must be implemented in the  OnSpinDown  and  OnSpinUp event handlers. In the specified handlers the resulting value must be specified in the  Text  component property.

Example

Properties of the SpinEdit Component

  Property name Brief description
Align The Align property determines the behavior of the component, when the size of its parent component is changed.
AllowDrag The AllowDrag property determines whether an object can be dragged from the component.
AllowDrop The AllowDrop property determines whether the component can accept a dragged object.
Anchors The Anchors property returns settings that determine the percentage of the size change for the current component when the parent component is resized.
AutoSelect The AutoSelect property determines, whether all the text of a component must be selected, when a component receives focus.
BorderStyle The BorderStyle property determines the style of a component border.
Brush The Brush property specifies the brush used to fill the component area.
CanUndo The CanUndo property returns True, if it is possible to undo text changes in the component.
CharacterCasing The CharacterCasing property determines the case of the entered characters.
ClientHeight The ClientHeight property is used to receive or specify the height of the component’s client space.
ClientWidth The ClientWidth property is used to receive or specify the width of the component’s client space.
Color The Color property determines the background color of a component.
ComponentCount The ComponentCount property returns the number of child components.
Components The Components property returns the child component.
Cursor The Cursor property determines the look of the cursor over the component.
Data The Data property is used to store any custom data.
EditorReadOnly The EditorReadOnly property determines whether the component text can be edited manually.
Enabled The Enabled property determines whether the component is available for the user.
Focused The Focused property returns True, if the focus is set on the component.
Font The Font property determines the set of characteristics, describing the font, used to display text.
Height The Height property determines the component height.
HelpContext The HelpContext property determines a unique index for the context help section for this component.
HideSelection The HideSelection property determines, whether the selected component text should remain the same, when the focus goes to another component.
Hint The Hint property determines the hint text for the component.
Left The Left property determines the coordinate of the left border of the component.
MaxLength The MaxLength property determines the maximum length of the entered text.
Modified The Modified property returns True, if the component text has been changed.
Name The Name property determines the component name.
Parent The Parent property determines the parent component.
ParentColor The ParentColor property determines whether the component inherits the color of the parent component.
ParentFont The ParentFont property determines whether the component should use the font of the parent component.
ParentShowHint The ParentShowHint property determines when a tooltip is displayed.
PasswordChar The PasswordChar property determines the character, which replaces the actual characters, entered by a user.
PopupMenu The PopupMenu property determines the context menu to be displayed on right-click.
ReadOnly The ReadOnly property determines, whether a user is able to change the component text.
Scrolls The Scrolls property returns parameters of component's scrollbars.
SelLength The SelLength property determines the number of characters selected in the component text.
SelStart The SelStart property determines the position of the cursor from which to start text selection in the component.
SelText The SelText property determines text, selected in the component.
ShowHint The ShowHint property enables and disables showing a hint for the component.
TabOrder The TabOrder property determines the component position in the tab order.
TabStop The TabStop property determines whether the focus is set to a component when the TAB button is pressed.
Tag The Tag property is not used by the compiler. The user can change the value of the Tag property and use it as required.
Text The Text property determines the row identifying a component for user.
Top The Top property determines the coordinate of the top border of the component.
Visible The Visible property determines the visibility of the component during execution.
Width The Width property determines the component width.

Methods of the SpinEdit Component

  Method name Brief description
BringToFront The BringToFront method brings a component to front.
Clear The Clear method deletes all the text in the input field.
ClearSelection The ClearSelection method deletes the records, selected in the input field.
ClearUndo The ClearUndo method is used to fix the changes of the Text property.
ClientToScreen The ClientToScreen method converts point coordinates relative to component coordinates into display coordinates.
CopyToClipboard The CopyToClipboard method allows to copy the selected data to clipboard.
CutToClipboard The CutToClipboard method allows to cut the selected data and place it to clipboard.
DoDragDrop The DoDragDrop method allows to start drag-and-drop operation.
GetImage The GetImage method returns the image of the component with all the child components.
PasteFromClipboard The PasteFromClipboard method pastes data from clipboard.
ScreenToClient The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system.
SelectAll The SelectAll method selects all the controls.
SendToBack The SendToBack method sends a component to back.
SetFocus The SetFocus method sets focus to this component.
Undo The Undo method allows to undo all the changes in the Text property after the last time the ClearUndo method was invoked.

Events of the SpinEdit Component

  Event name Brief description
OnBeginDrag The OnBeginDrag event occurs for a component, when a user starts to drag an object from the component.
OnChange The OnChange event occurs when the properties of the Text component are changed.
OnClick The OnClick event occurs if a user clicks a component area using the main mouse button.
OnDblClick The OnDblClick event occurs if a user double-clicks a component area using the mouse button.
OnDragDrop The OnDragDrop event occurs for a component if a user drops a dragged object over it.
OnDragEnter The OnDragEnter event occurs when a dragged object crosses the borders of this component.
OnDragLeave The OnDragLeave event occurs when a dragged object leaves the borders of this component.
OnDragOver The OnDragOver event occurs for this component when a user drags a dragged object over it.
OnEnter The OnEnter event occurs when a component receives focus.
OnExit The OnExit event occurs when a component loses focus.
OnHScroll The OnHScroll event occurs when the horizontal scrollbar slider changes its position.
OnKeyDown The OnKeyDown event occurs if a component is focused and a keyboard key is pressed.
OnKeyPress The OnKeyPress event occurs if a component is focused when a user presses a character key.
OnKeyPreview The OnKeyPreview event occurs prior to each event requiring clicking.
OnKeyUp The OnKeyUp event occurs if a component is focused and a user releases any button previously pressed.
OnMouseDown The OnMouseDown event occurs when the pointer is in component area and a mouse button is pressed.
OnMouseEnter The OnMouseEnter event occurs when mouse cursor enters the component area.
OnMouseHover The OnMouseHover event occurs when mouse cursor is held in the component area.
OnMouseLeave The OnMouseLeave event occurs when mouse cursor leaves the component area.
OnMouseMove The OnMouseMove event occurs on moving the cursor over component.
OnMouseUp The OnMouseUp event occurs on releasing mouse button when the cursor is in component area.
OnMouseWheel The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.
OnSpinDown The OnSpinDown event occurs when the SpinDown button is clicked in the edit field.
OnSpinUp The OnSpinUp event occurs when the SpinUp button is clicked in the edit field.
OnVScroll The OnVScroll event occurs when the vertical scrollbar slider changes its position.

See also:

Additional Components