Software Customisation
Reference Manual
Summary of Objects, Members and Methods
:
Object Type Details
: NUMERICINPUT Object
NUMERICINPUT Object
Members
Member
Type
Purpose
val
REALGet/Set
Value of the numeric input. Gets adjusted to the nearest value in the range.
range
REAL ARRAYGet/Set
Range: Start, End and Step(>0) as reals.
ndp
REALReadonly
Integer number of decimal places to be displayed. 0 means integer values.
modifiedEvents
BOOLEANGet/Set
Enable/disable modified events.
editable
BOOLEANGet/Set
Enable/disable editing of the displayed value.
Methods
Method Name
Result
Purpose
setRange( !range, !ndp )
NO RESULT
Set the range and number of decimal places. !range is an array of REAL, defining the min, max and step (>0) values. !NDP<0 leaves the current value unchanged.
Command
The NumericInput gadget allows numeric input within a specified range, with given granularity.
The Up/Down arrows control incrementing and decrementing the displayed value by the specified increment, within the range. Additionally it is possible to type in the required value. The number of decimal places can also be specified.
.-------<-------------------.
/ |
-- NUMERICinput gname -+- <fgtagw> ------------------|
+- <fgpos> -------------------|
+- <fganch> ------------------|
+- CALLback text -------------|
+- TOOLTIP text --------------|
+- CORE ----------------------* Core managed gadget
|-.-------<-------------------.
|/ |
+- RANGE val val -------------|
+- STEP val ------------------|
+- NDP int -------------------*
|
+- VALUE val -.
'-------------'- <vwid> -+- TOOLTIP text -.
'----------------'-->
Notes:
1.
The tag text is displayed.
2.
Default initial value is the minimum value of the range.
3.
The range maximum is adjusted to be an integral number of steps.
4.
NDP is the number of decimal places. If NDP is zero then all values will be integer.
5.
Typed in values will be adjusted to the nearest valid value in the range.
6.
The graph <vwid> allows the gadget width to be set specifically or in terms of other gadgets on the form.
7.
It is not possible to provide user formatting of the values displayed by the gadget.
Events and Callbacks
The Numeric input gadget supports SELECT and MODIFIED events, and users may provide a callback method to service these events. Note that often no callback is required, and the numeric input value is merely read and used by other gadgets of the form.
A SELECT event is raised whenever you press the ENTER key while the numeric input display field has focus. Typically this happens after you have typed in a required value, but will also apply if you enter the field after modifying the values using the up/down arrows. The callback can be a simple or an open callback.
A MODIFIED event is raised for each modification of the displayed value using the up/down arrows. Modified events are only reported if they are enabled and you have provided a PML open callback, as this allows differentiation from the SELECT events. The default state is modified events disabled.
1974 to current year.
AVEVA Solutions Limited and its subsidiaries. All rights reserved.
