TcxCustomSpinEditProperties Class

Represents settings specific to spin editors.

Declaration

TcxCustomSpinEditProperties = class(
    TcxCustomMaskEditProperties
)

Remarks

This class introduces new properties specific to spin editors. Use the Properties member of a specific editor to set its various settings. TcxSpinEditProperties (a TcxCustomSpinEditProperties descendant) simply publishes attributes provided by the TcxCustomSpinEditProperties class.

The Increment property specifies the amount by which the spin value is changed every time a user clicks the spin buttons or presses the Up Arrow, Down Arrow, Page Up, or Page Down key (or the Ctrl+Up Arrow, Ctrl+Down Arrow, Ctrl+Page Up, or Ctrl+Page Down key combination if the UseCtrlIncrement property is set to True). To limit numbers which a spin editor can represent, you can use the MaxValue and MinValue properties. They define the range of acceptable values.

A spin editor can represent either integer or double values. The ValueType property controls the type of the spin value and specifies the way in which the increment number is interpreted. You can prohibit end-users from editing the value directly via the Properties.CanEdit property. In this instance, the spin value can only be changed by clicking the spin buttons or pressing the keys described above.

The TcxCustomSpinEditProperties class provides two events to handle any changes made within the spin editor. These are the OnChange event which is fired every time the displayed value is changed and the OnGetValue event which is raised before the displayed value is converted to the edit value.