NumericParameterEdit
Description: |
Wrapper for ParameterEdit, used when adding a numeric parameter to a control. |
Returns: |
Self |
Usage: |
Steady State only. |
Function Groups: |
Basic Module, Variable |
Related to: |
ParameterEdit |
Format: |
NumericParameterEdit(Left, Bottom, Right, Top, ParmVal, ParmCodePtr, TagObjPreferred, Title, PtrWaitClose, DialogRoot, MinLimit, MaxLimit, PTypeIdx[, TitleWidth, ShowDrawnTagProperty, FocusID, Type]) |
Parameters: |
|
Left |
Required. Any numeric expression for the left edge of the object. |
Bottom |
Required. Any numeric expression for the bottom edge of the object. |
Right |
Required. Any numeric expression for the right edge of the object. |
Top |
Required. Any numeric expression for the top edge of the object. |
ParmVal |
The parameter value to be altered. |
ParmCodePtr |
The code pointer to the parameter. |
TagObjPreferred |
Set to TRUE to obtain a tag object when possible. |
Title |
The title to display. |
PtrWaitClose |
Wait to close. |
DialogRoot |
Root dialog calling this control. |
MinLimit |
Minimum limit of the selection. |
MaxLimit |
Maximum limit of the selection. |
PTypeIdx |
Index of the Parameter type selection. |
TitleWidth |
Optional, number of pixels allotted for the width of the title. |
ShowDrawnTagProperty |
Optional Boolean, set to TRUE to show "Drawn Tag Property". Defaults to TRUE. |
FocusID |
Optional value from 0 to 32767 for the focus ID of this control. |
Type |
Optional value specifying the type for the parameter. Defaults to Double. |
IsSpinBox |
Optional Boolean. When TRUE the numeric option is displayed as a spin box. |
ToolTitleWidthOut |
Optional numeric output value. Holds the width of the parameter edit's tool and title. |
Comments: |
Automatically determines what module to use for display and entry of the existing value. |
Example:
ParmEditObj = \NumericParameterEdit(0, 2 * (EditHt + Space), PanelWd, 0,
Parms[#DataSource] { Parameter Value },
ParmCodePtrs[#DataSource] { Pointer to Parm Code },
1 { Tag object preferred },
\GetPhrase("DataSourceLabel") { Title },
&SubWaitClose { Wait to close },
DialogRoot { Calling dialog window},
LowScale { MinLimit },
HighScale { MaxLimit });
Trihedral and VTScada are registered trade marks of Trihedral Engineering Limited
© Trihedral Engineering Limited 1983- 2022 All rights reserved.