ParameterEdit Snap-ins 
These modules are accessories toParameterEdit
ParameterEdit is used for handling the value of a parameter in the user interface. Snap-Ins are modules that can be paired with ParameterEdit to identify the type of parameter value to be edited along with parameters specific to that use case.
How to Use Snap-Ins
- Use the name of the snap-in module in the Modules Array parameter of ParameterEdit.
(such as, Modules[0] = "ParmEditColor") - Parameters needed for all uses of ParameterEdit (like ParmVal, ParmPtr, Enable) are to be configured in ParameterEdit. Do not include them in your array.
- Parameters specific to the snap-in go into the Parameters array.
The Parameters array might look something like this:
Modules[1] = "ParmEditExprNoNormalize";
Parameters[1] = New(4); {allocates memory for an array, specifies a size 4, for 4 parms}
Parameters[1][0] = 0b1001; {MenuEnables}
Parameters[1][1] = ContainerInfo; {ContainerInfo}
Parameters[1][2] = #VTypeFont; {TargetType}
Parameters[1][3] = "FontValue"; {TargetSubType}
The first 11 parameters in the snap-in (Expr, ParmPtr, Enable, Left, Bottom, Right, Top, LabelWidth, LabelHeight, PtrWaitClose, DlgRoot) are configured in ParameterEdit so they are no included in the array.
ParameterEdit Wrappers
VTScada has a growing catalog of ParameterEdit Wrappers. These are modules that are like ParameterEdits that have already been partially configured. Before making your own customized ParameterEdit-- Check out our wrapper options!
ParmEditColor - Choose a Color
First, check out the wrapper ColorParameterEdit. It might save you some leg work!
| Description | Used for choosing a color as your parameter value. |
| Required Parameters | None |
| Parameters |
Color - Parameter value |
ParmEditColorNone - Choose Invalid for Color
| Description | Used for choosing an Invalid color as your parameter value. |
| Required Parameters | None |
| Parameters |
Color - Parameter value |
ParmEditColorSS - For Displaying a Color from a StyleSetting Tag
| Description | Used to display a color from a Style Setting tag |
| Required Parameters | None |
| Parameters |
Color - Parameter value |
ParmEditDateTime - Choose a Timestamp Value
| Description | Used for choosing a time stamp value. It expects and returns timestamps in UTC, and converts them to the clients local time zone for display and edit. |
| Required Parameters | None |
| Parameters |
TimestampVal - Parameter value (expected in UTC) TimeOnly - Optional. When set to TRUE, only time will be displayed. Defaults to FALSE |
ParmEditDuration - Choose a Duration of Time
| Description | Used for choosing a duration of time as your parameter value. It consists of a numeric entry field to enter a multiplier, and a drop-list of time units (Days, Weeks, Months, etc) to choose from. |
| Required Parameters | None |
| Parameters |
DurationVal - Parameter value |
ParmEditDroplist - Choose a Value Using a Droplist
| Description | Allow a value to be changed using a droplist. |
| Required Parameters | None |
| Parameters |
ParmVal - Parameter value ParmValues - List of values ParmLabels - List of labels or PhraseIDs IsText - TRUE if the values are text, FALSE if numeric (Default). |
ParmEditExprMovement - Choose an Expression for a Movement Parameter
| Description | Used for choosing an expression as your parameter value for a movement parameter |
| Required Parameters | DropListLabel0, DropListLabel1, ContainerInfo, DefMin, DefMax |
| Parameters |
Expr - Parameter value |
ParmEditExprNormalize - Choose an Expression, Wrapped in Normalize
| Description | ParameterEdit module for choosing an expression as your parameter. The result is wrapped in a Normalize. |
| Required Parameters | MenuEnables, ContainerInfo |
| Parameters | Expr - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label height PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) MenuEnables - Bits to enable options for expression editor bit 0 - Tag Browser bit 1 - Color Selector bit 2 - Gradient Selector bit 3 - Function Selector and Editor ContainerInfo - Information structure for Container and its parameters |
ParmEditExprNoNormalize - Choose an Expression, Without Normalize
| Description | Used for choosing an expression as your parameter. Note that, the result is not wrapped with a Normalize. |
| MenuEnables, ContainerInfo, TargetType, TargetSubType | |
| Parameters |
Expr - Parameter value |
ParmEditFont - Choose a Font
ParmEditFont differs from others. You will need to add an element to your Modules array with the value of "ParmEditFont".
The Parameters array can have an Invalid entry for the matching element.
| Description | Used by the ParameterEdit to choosing a Font as your parameter value. See note at the beginning of this article. |
| Required Parameters | BrowserObj |
| Parameters | FontVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID BrowserObj - Output: Set to the instance of the Tag Browser opened by the SelectObject control. |
ParmEditHorizAlign - Choose a Horizontal Alignment
| Description | ParameterEdit module for choosing horizontal alignment as your parameter value. |
| Required Parameters | None |
| Parameters | HAlign - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID |
ParmEditLineStyle - Choose a Line Style
| Description | ParameterEdit module for choosing a line style as your parameter value |
| Required Parameters | None |
| Parameters | Style - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID |
ParmEditLineWidth - Choose a Line Width
| Description | ParameterEdit module for choosing a line width as your parameter value |
| Required Parameters | None |
| Parameters | Width - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID |
ParmEditNum - Choose a Numeric Value
First, check out the wrapper NumericParameterEdit. It might save you some leg work!
| Description | ParameterEdit module for choosing a number as your parameter value |
| Required Parameters | TypeOfValue, MinVal, MaxVal, IsSpinBox |
| Parameters | NumVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) TypeOfValue - Optional, VTScada value type required MinVal - Optional, Min value allowed (Max also required) MaxVal - Optional, Max value allowed (Min also required) IsSpinBox - Optional, set TRUE to display as a spinbox. |
ParmEditNumSlider - Configure a Numeric Slider Bar or Optional Edit Field
| Description | ParameterEdit module for choosing a number as your parameter value using a slider bar or optional edit field. |
| Required Parameters | MinVal, MaxVal, EnableEditField |
| Parameters | NumVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width HideTitle - set TRUE to hide the title over the control PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID MinVal - Optional, Min value allowed (Max also required) Default 0 MaxVal - Optional, Max value allowed (Min also required) Default 100 EnableEditField - Optional, set FALSE to disable the edit field. Default TRUE. |
ParmEditParmMovement - Get Info for Displaying the Movement Parameter
| Description | ParameterEdit module for choosing a container's parameter as a value. Used for displaying the Movement parameter. Has all the additional information needed for the Movement GUI call |
| Required Parameters | ContainerInfo, DropListLable0, DropListLabel1, DefMin, DefMax |
| Parameters | ParmVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ContainerInfo - Info struct for the container and its parameters DropListLabel0 - Droplist label 0 DropListLabel1 - Droplist label 1 DefMin - Default minimum value DefMax - Default maximum value |
ParmEditParmValue - Choose a Container's Parameter as a Value
Due to the introduction of PickValids for default parameters, this selector must appear in the modules array before any of the expressions.
| Description | ParameterEdit module for choosing a container's parameter as a value. |
| Required Parameters | ContainerInfo, TargetTypeLo, TargetTypeHi, SubTypeList, Scaled, DefaultValue, DefaultNoParm, TargetMin, TargetMax, Translate |
| Parameters | ParmVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (for sizing) ContainerInfo - Info struct for container and its parameters ValueTypeLo - Min value type allowed for this parameter. Note - If ValueTypeHi is invalid, then this is the only value type allowed. ValueTypeHi - Max value type allowed for this parameter SubTypeList - Optional list of subtypes for object type Scaled - Optional Boolean to indicate whether the data be in a "Scale" expression. The default is FALSE DefaultValue - Optional. The default value if the parameter's value is invalid DefaultNoParm - Optional. The default value if no parameter is selected TargetMin - Target minimum value TargetMax - Target maximum value Translate - Boolean. Set TRUE if the output should be wrapped in \GetPhrase. |
ParmEditPageVariable - Get a Variable Name
| Description | ParameterEdit module takes a variable name as a parameter and proffers it when selected. |
| Required Parameters | None |
| Parameters | VariableVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width HideTitle - TRUE to hide the title over the control PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID VarName - The name of the page variable to use. |
ParmEditPattern - Choose a Fill Pattern as a Parameter Value
| Description |
ParameterEdit module for choosing a fill pattern as your parameter value |
| Required Parameters | NoTransparentBrush |
| Parameters | Brush - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID NoTransparentBrush - Boolean. Set FALSE to show a "no pattern" selection. Defaults to TRUE. |
ParmEditPipeColor - Choose a Pipe Color as a Parameter Value
| Description | ParameterEdit module for choosing a pipe color as your parameter value |
| Required Parameters | None |
| Parameters | HighColor - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID |
ParmEditPipeWidth - Choose a Pipe Width as a Parameter Value
| Description | ParameterEdit module for choosing a pipe width as your parameter value |
| Required Parameters | None |
| Parameters | PipeWidth - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID |
ParmEditTag - Choose a Tag as a Parameter Value
First, check out the wrapper TagParameterEdit. It might save you some leg work!
| Description | Parameter Editing module for choosing a tag as your parameter value |
| Required Parameters | PointType, BrowserObj, DefaultText, MissingText |
| Parameters | TagParm - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the Parameter Value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label weight PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) PointType - Point Type allowed for this parameter BrowserObj - Output: Set to the instance of the Tag Browser opened by the SelectObject control. |
ParmEditTagMovement - Choose a Tag Value for a Movement Parameter
| Description | Parameter Editing module for choosing a tag value as your parameter value for a Movement parameter |
| Required Parameters | DropListLabel0, DropListLabel1, PointType, DefMin, DefMax, BrowserObj |
| Parameters | TagMoveVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label height PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) DropListLabel0 - Label 0 for the movement direction drop-list DropListLabel1 - Label 1 for the movement direction drop-list PointType - Point Type allowed for this parameter DefMin - Default minimum value DefMax - Default maximum value BrowserObj - Output: Set to the instance of the Tag Browser opened by the SelectObject control. |
ParmEditTagProperty - Choose a property of a Drawn Tag
Due to the introduction of PickValids for default parameters, this selector must appear in the Modules array BEFORE any of the Expressions
| Description | ParameterEdit module for choosing a property of the drawn tag. |
| Required Parameters | ContainerInfo, TargetTypeLo, TargetTypeHi, TargetSubTypes, Scaled, DefaultValue, DefaultNoTag, TargetMin, TargetMax |
| Parameters | ParmVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label height PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (for sizing) ID - Focus ID ContainerInfo - Info struct for container and its parameters TargetTypeLo - Min value type allowed for this parameter. If TargetTypeHi is Invalid, then this is the only value type allowed. TargetTypeHi - Max value type allowed for this parameter TargetSubTypes - Optional list of subtypes for object type Scaled - Should this value be scaled? DefaultValue - Optional, default value if the tag's value is invalid DefaultNoTag - Optional, default value if user selects 'No Property Selected' TargetMin - Target minimum value TargetMax - Target maximum value |
ParmEditTPMovement - Choose a Container's Parameter as a Value
| Description | ParameterEdit module for choosing a container's parameter as a value |
| Required Parameters | DropListLabel0, DropListLabel1, ContainerInfo, DefMin, DefMax |
| Parameters | ParmVal - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label height PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (for sizing) DropListLabel0 - Label 0 for the movement direction drop-list DropListLabel1 - Label 1 for the movement direction drop-list ContainerInfo - Info structure for container and its parameters DefMin - Default minimum value DefMax - Default maximum value |
ParmEditTagValue - Choose a Tag Value as a Parameter Value
| Description | ParameterEdit module for choosing a tag value as your parameter value |
| Required Parameters | PointType, Scaled, DefaultValue, DefaultNoTag, TargetMin, TargetMax, BrowserObj |
| Parameters | TagParm - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label height PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) PointType - Point type allowed for this Parameter Scaled - Optional Boolean value indicating whether the data should be in a Scale expression. Default = true DefaultValue - Optional, default value if the tag's value is invalid DefaultNoTag - Optional, default value if no tag is set |
ParmEditVertAlign - Choose a Vertical Alignment
| Description | ParameterEdit module for choosing vertical alignment as your parameter value. |
| Required Parameters | None |
| Parameters |
VAlign - Parameter value Mode - 0 = values are 0, 3, 6 (Default). 1 = values are 0, 1, 2 |
ParmEditText - Choose Text as a Parameter Value
First, check out the wrapper TextParameterEdit . It might save you some leg work!
| Description | ParameterEdit module for choosing a text string as your parameter value |
| Required Parameters | Translate, PageName |
| Parameters |
TextMsg - Parameter value FocusID - Focus ID Translate - Integer indicating whether the output should be wrapped in \GetPhrase. PageName - Which page we set this text parameter for. Mandatory for editing a subordinate page (name in the form of <SubordinateApplicationTagName\PageNameOnSubordinateApp>) so that any text parameter entered can save its phrase identifier key on subordinate application. |
ParmEditTextExpression - Choose an Expression to Return Text as a Parameter Value
Related to ParameterPanel, described elsewhere in this topic.
| Description | ParameterEdit module for choosing an expression that returns text as the parameter Value. |
| Required Parameters | MenuEnables, ContainerInfo |
| Parameters | Expr - Parameter value ParmPtr - Parameter pointer Enable - Show the graphics for editing the parameter value Left - Left coordinate Bottom - Bottom coordinate Right - Right coordinate Top - Top coordinate LabelWidth - Label width LabelHeight - Label height PtrWaitClose - TRUE to tell caller to wait to close DlgRoot - Root of the edit dialog (UNUSED) ID - Focus ID MenuEnables - Bits used to enable options for the expression editor bit 0 - Tag Browser bit 1 - Color Selector bit 2 - Gradient Selector bit 3 - Function Selector and Editor ContainerInfo - Info structure for Container and its parameters |
Accessory to ParameterEdit - ParameterPanel - Not a Snap-In
This is not a snap-in. It is a wrapper of ParameterEdit.
| Description | This is a Generic Panel which will handle the setting of Parameters for an object that does not have its own panel. The object can be a page or a widget. If available, hints are taken from the typing information of the object parameters and suitable Parameter Value choosers are offered. If the immediate container has parameters then, these too are considered as actual value candidates. However, if there is type information on the object or the container, then these hints are used to filter the set of options, possibly resulting in an empty set. This panel is designed to be callable from several sources, such as the VGE and the Display Manager. |
| Parameters | ObjModule - Object module that is to have its parameters modified pObjParams - Pointer to an array of the object's parameter values PtrWaitClose - TRUE when window closed or cancel pressed CodePtr - CodePtr so that the parameter value can be read Left - Left position of the window Bottom - Height of window Right - Width of the window Top - Top position of the window HandleScrollBar - Flag - TRUE for this module to use a scrollbar if required ContainerInfo - Information about container and its parameters SelectedParms - Boolean array of selected parameters to make editable DialogRoot - The calling dialog window GetWidthFromDescriptions - Optional. If TRUE, the larger of Description or Name is used to determine the space required. AllowAdvancedParams - Optional. Allows advanced parameter configuration. This will change which options are available for editing parameters. PageName - Which page the parameter is set for. Mandatory for editing a subordinate page (name in the form of <SubordinateApplicationTagName\PageNameOnSubordinateApp>) so that any text parameter entered can save its phrase identifier key on subordinate application. Leave invalid when editing the parameters of a widget. |
