TagParameterEdit

(VTScada-Layer function. Must be called with a leading backslash.)

Description:	Wrapper of ParameterEdit which makes for easy addition of a ParameterEdit control to a panel for selecting tags
Returns:	Self
Usage:	Steady State only.
Function Groups:	Basic Module, Variable
Related to:	ParameterEdit | ColorParameterEdit | NumericParameterEdit | TextParameterEdit | TimestampParameterEdit
Format:	\TagParameterEdit(Left, Bottom, Right, Top, ParmVal, ParmCodePtr, Title, PtrWaitClose, DialogRoot, PTypeIdx, TitleWidth, ShowLinkedTagProperty, ID[, TagType, DefaultText, MissingText, TagObj] )
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

Required. The parameter value to be altered. Typically, one element of the array of Parms passed to the panel.

ParmCodePtr

Required. The code pointer to the parameter. Typically, one element of the array of parameter definition structures.

Title

The title to display

PtrWaitClose

Wait to close Typically provided by the panel module.

DialogRoot

Root dialog calling this control Typically provided by the panel module.

PTypeIdx

Index of the Parameter type selection

TitleWidth

Optional, number of pixels allotted for the width of the title.

ShowLinkedTagProperty

Optional Boolean. Set true to show "Linked Tag Property". Defaults to TRUE

ID

Focus ID

TagType

Optional. Tag type or group

DefaultText

Optional text to display in place of "No tag selected"

MissingText

Optional text to display in place of "--Missing--"

TagObj

Optional. [OUT] Resolved tag object

Comments:

...

Example:

ParmEditObj[0] = TagParameterEdit(0 + Space       { Placement coordinate                          },
                    EditHt + Space + TitleSpace   { Placement coordinate                          },
                    #PanelWd - Space              { Placement coordinate                          },
                    Space + TitleSpace            { Placement coordinate                          },
                    Parms[#FontParm]              { The Parameter value to alter                  },
                    ParmDefs[#FontParm]           { The code pointer to the parameter             },
                    GetPhrase("FontLabel")        { The title to display                          },
                    &(SubWaitClose[0])            { Wait to close                                 },
                    DialogRoot                    { Root dialog calling this control              },
                    Invalid                       { Index of the Parameter type selection         },
                    TitleWidth                    { Width alloted for the Title                   },
                    TRUE                          { True to show "Drawn Tag Property";
                                                    default = TRUE                                },
                    1                             { Focus ID                                      },
                    "FontValue"                   { Tag type or group                             },
                    GetParmPhrase("NoPointLabel", #SYSTEM_STYLE) { Text to display in place of No tag selected   },
                    GetParmPhrase("NoPointLabel", #SYSTEM_STYLE) { Text to display in place of --Missing--       });