TextParameterEdit

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

ShowDrawnTagProperty

Boolean. Set true to show "Drawn Tag Property". Defaults to TRUE

ID

Focus ID

Translate

Optional. Controls how translation should be handled: 0 - Use text as it is entered 1 - Use PhraseID Wrapped in GetPhrase() (Default) 2 - Use PhraseID not wrapped in GetPhrase()

ToolTitleWidthOut

Optional. [OUT] Width of ParmEdit's tool and title

Description

Optional text describing this parameter

NLines

Optional. Height of the edit field; defaults to 2 lines

Comments:

...

Example:

 { Label }
PEObj[0] = TextParameterEdit(2*Space, 
                             2*EditHt, 
                             #PanelWd, 
                             0,
                             Parms.ButtonLabel, 
                             ParmDefs.ButtonLabel,
                             GetPhrase("LabelLabel"), 
                             &SubWaitClose[0], 
                             DialogRoot,
                             0, 
                             TitleWd, 
                             TRUE, 
                             1 { FID }, 
                             0 { Use text as it is entered },
                             Invalid, 
                             Invalid, 
                             1 { NLines });