ColorParameterEdit

(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 colors
Returns:	Self
Usage:	Steady State only.
Function Groups:	Basic Module, Variable
Related to:	ParameterEdit | NumericParameterEdit | TagParameterEdit | TextParameterEdit | TimestampParameterEdit
Format:	\ColorParameterEdit(Left, Bottom, Right, Top, ParmVal, ParmCodePtr, Title, PtrWaitClose, DialogRoot, PTypeIdx, TitleWidth, ShowLinkedTagProperty, ID[, ShowStyleSettings, StyleSettings, StyleColorName, DisableAlpha])
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

The 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

ShowStyleSettings

Optional. True to show "Style Settings" def = TRUE

StyleSettings

Optional. StyleSettings tag object

StyleColorName

Optional. Name of the StyleSettings color to use

DisableAlpha

Optional. Flag for disabling alpha field

Comments:

Be careful when setting “ShowStyleSettings” that the color being edited is related to style setting tags.

Example:

{***** Color *****}
ParmObj[4] = ColorParameterEdit(0 + Space   { Placement coordinate                     },
               PEBottom[4] + Space + TabHt  { Placement coordinate                     },
               #PanelWd - Space             { Placement coordinate                     },
               PEBottom[4] + Space          { Placement coordinate                     },
               Parms[#Color]                { The Parameter value to alter             },
               ParmDefs[#Color]             { The code pointer to the parameter        },
               GetPhrase("TextLabel")       { The title to display                     },
               &(SubWaitClose[4])           { Wait to close                            },
               DialogRoot                   { Root dialog calling this control         },
               0                            { Index of the Parameter type selection    },
               TitleWidth                   { Width allotted for the Title             },
               TRUE                         { True to show "Drawn Tag Property";
                                               default = TRUE                          },
               1                            { Focus ID                                 },
               FALSE                        { True to show "Style Settings" def = TRUE });