Object PmgWEdit (EditBox)
Description:
The object serves for entering or displaying a value similarly to the PmgString object.
Contrary to the PmgString object it allows to enter the value by editing on place (the object switches, for example, after pressing the left mouse button, into the edit mode when it has cursor).
Editing on place allows in addition, for example, the PmgWTable object.
The object value is stored in the Value property. Its possible data binding specifies the source (and destination) where the value is written in the time of entering a new value, see the onDataEditAccept event.
The data binding is here "for read and write", it means that if the source of the data binding is changed by other methods, then the change of this source is reflected into the change of the object, i.e. the object displays the changes of this referred variable (if the object is not switched into edit mode).
The object is not limited to the text size, i.e. the text of large size can be shown there (it is meaningful only if the "Multiline text" configurator is checked).
This object is the Window Pmg object.
This object inherits properties, methods and events of the PmgObject object.
Properties and methods of this object:
| ColorItem | Background color |
|---|---|
| ColorText | Color of the text value |
| Value | Displayed value |
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 final change of the object content |
|---|---|
| onDataEditCancel | Is triggered by pressing the Esc key |
| onDataEditing | Is triggered on changing the object content |
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 |
| onMousePress | Is triggered after pressing or releasing the left mouse button |
| 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 |
| Edit | Properties of the PmgWEdit object |
| Attributes | Attributes of the PmgWEdit object |
History:
Pm8.03.23: Fixed bug: Editing in multiline mode.
Pm8.03.22: Fixed bug: The setting "Read only" was not working on the Web. Editing was always possible.
Pm8.03.16: Fixed bug: While entering value by the Enter key the onDataEditAccept event was not triggered.
Pm8.03.10: Fixed bug: Is now functional also for German localization setting of the Windows OS (where the number contains separator of thousands "period").
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).
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