Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Object PmgButtonState (Two-states button)

Description:
The button is determined for switching two states, for example on-off. After pressing the button the internal state of the button is toggled (0->1 or vice versa) and the onButtonUp event is triggered. The button state is graphically expressed by displayed text or by displayed bitmap and internally stored in the State property.
This object inherits properties, methods and events of the PmgBox object.
Properties and methods of this object:
ColorText Text color in the button for the state 0
ColorText1 Text color in the button for the state 1
ImageSrc The file name with the path to the image file displayed on the button in the state 0
ImageSrc1 The file name with the path to the image file displayed on the button in the state 1
State State of the two-state button (0 or 1)
StateEx Returns one of five button states
Text Text in the button for the state 0
Text1 Text in the button for the state 1
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:
AddEvent Registers a function into selected 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 Name of the Pmg object including the path that consists of parent Pmg objects names
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 upper-left corner of the Pmg object relative to superior object
IniY Initial Y-position of the upper-left 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 or to its subobject (obsolete)
PmPanel Returns reference to the PmaPanel object where the Pmg object is placed
Refresh Refresh of the Pmg object
RemoveEvent Deregisters 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 upper-left corner of the Pmg object relative to computer screen
ScreenY Y-coordinate of the upper-left 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 upper-left corner of the Pmg object relative to the PmgRoot object
ViewY Position of the Y-coordinate of the upper-left corner of the Pmg object relative to the PmgRoot object
Visible Sets the visibility/invisibility of the Pmg object
X X-coordinate of the upper-left corner of the Pmg object relative to superior Pmg object
Y Y-coordinate of the upper-left corner of the Pmg object relative to superior Pmg object
Events of this object:
onButtonUp Is triggered on pressing the button by the keyboard or the mouse
Properties and methods inherited from the PmgObject:
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 an item from the Pmg object local 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's method of the Pmg object
Box Setting the background area of the Pmg object
Button Common properties of two-state button
State Button properties in the state 0 or 1
See also:
- PmgButton (object)

History:
Pm8.00.07: Icon and text alignment is now working. If the "Show image" configurator is set to "left from text" and the text is still aligned to the left, then the icon is also aligned to the left together with the text (it was always centered in the previous versions). It is functional also for Web panels.
Pm9.00.00: Object name changed: PmiButtonTwo -> PmgButtonState
PROMOTIC 9.0.17 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice