Object PmgString (Text)
Description:
The object serves for displaying and editing text strings.
Displayed value of the object can be linked up by data binding in the "Value" configurator. Then the object displays the current value of any variable in the PROMOTIC system or the value of the common expression.
For displaying and for entering the value a similar PmgWEdit object can be used (entering the value on the place in the object).
This object inherits properties, methods and events of the PmgBox object.
Properties and methods of this object:
| ColorText | Text color |
|---|---|
| FontId | Font identifier |
| Multiline | Enable/disable displaying the text on more than one row |
| PaddingLeft | Left text padding |
| PaddingRight | Right text padding |
| Value | Displayed value |
Properties and methods inherited from the PmgBox object:
| BorderType | Type of the box border |
|---|---|
| BorderWidth | Width of the box border |
| ColorDark | Dark color of the 3D Pmg object border |
| ColorItem | Background color of the box |
| ColorLight | Light color of the 3D Pmg object border |
Properties and methods inherited from the PmgObject object:
| AddEvent() | Registers a function into the specified event |
|---|---|
| Blink() | Starts/stops blinking of the Pmg object |
| Dx | Width of the Pmg object |
| Dy | Height of the Pmg object |
| Enabled | Enable/disable the control, i.e. user's inputs to the object |
| Focus | Detects/set the focus of the Pmg object |
| GetChildByIndex() | Returns the nested Pmg object defined by order |
| GetChildCount() | Returns the number of nested Pmg objects |
| GetPathName() | Object name with the path to this object |
| GetItemInfo() | Returns special information regarding the Pmg object |
| GetPar() | Reading the value of the Pmg object parameter (or its parents) |
| IniDx | Initial width of the Pmg object |
| IniDy | Initial height of the Pmg object |
| IniX | Initial X-position of the left upper corner of the Pmg object relative to superior object |
| IniY | Initial Y-position of the left upper corner of the Pmg object relative to superior object |
| Items() | Returns reference to the Pmg object |
| Methods | Access to designer methods of this object |
| MouseOn | Identification if the mouse cursor finds itself over the Pmg object |
| Name | The name of the Pmg object |
| Parent | Returns reference to the parent Pmg object |
| Pm() | Returns the Pma object (obsolete) |
| PmPanel | Returns reference to the PmaPanel object where the Pmg object is placed |
| Refresh() | Refresh of the Pmg object |
| RemoveEvent() | Unregisters the function in the specified event |
| Root | Returns reference to the root PmgRoot object |
| ShowMenu() | Opens context menu of the Pmg object |
| ScreenX | X-coordinate of the left upper corner of the Pmg object relative to computer screen |
| ScreenY | Y-coordinate of the left upper corner of the Pmg object relative to computer screen |
| ToolTip | Tooltip text of the Pmg object |
| Vars() | Returns the variable of the Pmg object |
| ViewX | Position of X-coordinate of the left upper corner of the Pmg object relative to the PmgRoot object |
| ViewY | Position of the Y-coordinate of the left upper corner of the Pmg object relative to the PmgRoot object |
| Visible | Visibility of the Pmg object |
| X | X-coordinate of the left upper corner of the Pmg object relative to superior Pmg object |
| Y | Y-coordinate of the left upper corner of the Pmg object relative to superior Pmg object |
Events of this object:
| onDataEditAccept | Is triggered after editing the object value is ended |
|---|---|
| onValueChanged | Is triggered after change of the object value |
Events inherited from the PmgObject object:
| onStart | Is triggered on the construction of the Pmg object in the course of opening the panel |
|---|---|
| onStop | Is triggered on the destruction of the Pmg object in the course of closing the panel |
| onRefresh | Is triggered on the data refresh of the Pmg object |
| onKeyPress | Is triggered after pressing or releasing the key of the keyboard |
| onMousePress | Is triggered after pressing or releasing the left mouse button |
| onMenuFill | Is triggered after pressing by the right mouse button over the Pmg object |
| onMenuSelect | Is triggered on the selection of the item from the Pmg object context menu |
| onModeChange | Is triggered when the Pmg object mode changes |
| onFocusIn | Is triggered if the object receives focus |
| onFocusOut | Is triggered if the object loses focus |
Configuration tabs:
| Object | General information about the object |
|---|---|
| Position | Setting the position, width and height of the Pmg object |
| Variables | List and configuration of user defined Pmg object variables |
| Events | Algorithms definition for the object events |
| Methods | Definition of designer method of the Pmg object |
| Box | Setting the background area of the Pmg object |
| Text | Text properties. |
See also:
-
PmgNumber (object)
History:
Pm9.00.16: New event onValueChanged
Pm8.03.23: Fixed bug: Editing in multiline mode.
Pm8.03.21: Improved font smoothing for big fonts (greater than 100px).
Pm8.03.10: Is now functional also for German localization setting of the Windows OS (where the number contains separator of thousands "period").
Pm8.02.06: Direct editing is now available (similar as in the PmgWEdit object). Before, it was possible to edit the value only by opening an extra window. See the "Type of editing" configurator.
Pm8.01.05: in the Web panel the "Value format type" configurator sometimes did not work if set to formatting rule of %f or %e.
Pm8.01.01: The Value property used to be of the String type, but now (according to the "Data type of entered value" configurator) returns the value of String, Integer or Float type. The old behavior can be activated in the "Always return String (obsolete)" configurator (the objects that are already existing will use the old setting so the behavior remains the same as before).
PROMOTIC 9.0.31 SCADA system documentation MICROSYS, spol. s r.o.
Send page remarkContact responsible person
Send page remarkContact responsible person