Object PmgWCombo (ComboBox)
Description:
The object serves for entering the value by the selection from the list of pre-defined values. The selected value can be either an index, visible text or invisible value - see the "The selected value is" configurator. The list can be displayed in the running application by the Alt+Down keys, texts can be selected by the Down/Up keys.
The selected option is stored in the SelectedIndex, SelectedText and SelectedValue properties. If the selected value has a data binding, then the value is written into the variable referred to by data binding on changing the ComboBox value respectively in the time that is set on the "Attributes" tab (on the Enter key, on the selection from the menu, etc.). The data binding is here "for read and write", it means that if the variable of the data binding is changed even by other methods, then the change of this variable is reflected into the change of the ComboBox value.
This object is the Window Pmg object.
This object inherits properties, methods and events of the PmgObject object.
Properties and methods of this object:
| AddOption() | Adds an option into the list |
|---|---|
| ColorItem | Background color |
| ColorText | Text color |
| Options() | Reading visible texts, hidden values or whole options from the list by the index |
| OptionsCount | The number of options in the list |
| RemoveOptions() | Clearing the list |
| SelectedIndex | Index of the selected text |
| SelectedText | Selected visible text |
| SelectedValue | Hidden value associated with selected visible text |
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 Pmg object |
| Methods | Access to designer's 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 local 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 | Sets the visibility/invisibility 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 on ending the value selection |
|---|---|
| onDataEditCancel | Is triggered by pressing the Esc key |
| onDataEditing | Is triggered on changing the selected 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 |
| 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's method of the Pmg object |
| Combo | Properties of the PmgWCombo object |
| Attributes | Attributes of the PmgWCombo object |
History:
PROMOTIC 9.0.27 SCADA system documentation MICROSYS, spol. s r.o.
Send page remarkContact responsible person
Send page remarkContact responsible person