Class: dbSpinForm

Properties  Events  Methods    Index of Classes

Provides an entry form that users can edit that contains an integer or date that can be driven through a range with buttons

Hierarchy

cObject
---cUIObject
------DfBaseObject
---------DfBaseWindow
------------DfBaseUIWindow
---------------DfBaseControl
------------------DfBaseList
---------------------DfBaseForm
------------------------DfBaseEntry
---------------------------Entry
------------------------------dbForm_
---------------------------------dbFormDS
------------------------------------dbSpinFormDS
---------------------------------------dbSpinForm

Library: Windows Application Class Library

Package: Dfspnent.pkg

Mixins: Extended_DEO_Mixin Extended_DEO_Status_Help_Mixin Extended_DEO_Spin_Mixin Extended_DEO_Status_Help_Tooltip_Mixin

Description

dbSpinForm is used to provide an entry form that users can edit that contains an integer or date that can be driven through a range with buttons. The value can be manually changed by users in the entry form and the spin buttons will pick up the modified value, and resume spinning from that value.

Sample

Object MyForm is a DbSpinForm
    Set Size to 13 100
    Set location to 15 70
    Entry_Item Customer.Discount
    Set Label to "Discount:"
End_Object
 
Object MyDate is a DbSpinForm
    Set Size to 13 100
    Set location to 15 70
    Entry_Item OrderHea.Date
    Set Label to "Order Date:"
End_Object



Syntax

Dfspnent.pkg
 
// when data field is connected to a DataDictionary
Object oObjectName is a dbSpinForm
    Set Size to height width
    Set location to Row Column
    Entry_Item table.column
    Set Wrap_State to true|false
 
    set Auto_Label_State to true| false
    Set Label to text
    Set Label_Justification_Mode to mode
    Set Label_Row_Offset to Num
    Set Label_Col_Offset to Num
    Set Enabled_State to true|false
 
    Procedure OnChange
    End_Procedure
 
    Procedure OnSetFocus
    End_Procedure
 
    Procedure OnKillFocus
    End_Procedure 

End_Object


When using a function:

Object oObjectName is a dbSpinForm
    Set Size to height width
    Set Location to row column

    Entry_Item {(FunctionName(Self))}

    Set Wrap_State to true|false
    Set Maximum_Position to MaxValue
    Set Minimum_Position to MinValue
 
    Set Label to text
    Set Label_Justification_Mode to mode
    Set Label_Row_Offset to Num
    Set Label_Col_Offset to Num
 
    Set Form_DataType 0 to mode
    Set Form_Margin 0 to mode
    Set Form_Mask 0 to maskstring
    Set Numeric_Mask 0 to leftDigits rightDigits {template}
    Set Currency_Mask 0 to leftDigits rightDigits {template}
 
    Set Enabled_State to true|false
    Set Status_Help to text
 
    Procedure OnChange
    End_Procedure
 
    Procedure OnSetFocus
    End_Procedure
 
    Procedure OnKillFocus
    End_Procedure

End_Object


Of Special Note

DbSpinForm is a subclass of dbForm and inherits all of its behaviors. Refer to dbForm for information on the basic usage of this class.

The range of a spinner is set with the Minimum_Position and Maximum_Position properties. When using the dbSpinForm with a data-dictionary object, these ranges can be determined automatically.

The spin button will appear as an integrated part of your form - it appears inside the form and is right justified.

Spin buttons are capable of a maximum range of 32K, within the range ±32K. Both numbers and dates are automatically supported with this object. String values may also be supported, but will require the augmentation of the get and set Spin_Value messages to make this conversion.