Visualization Element 'Button'

Symbol:

Category: “Common Controls”

The element triggers an action, such as setting a variable.

Element properties

“Element name”

Optional

Hint: Assign individual names for elements so that they are found faster in the element list.

Example: ‎Voltage_on‎

“Type of element”

“Button”

Element property 'Position'

The position defines the location and size of the element in the visualization window. These are based on the Cartesian coordinate system. The origin is located at the upper left corner of the window. The positive horizontal x-axis runs to the right. The positive vertical y-axis runs downwards.

“X”	X coordinate of the upper left corner of the element Specified in pixels. Example: `‎10‎`.
“Y”	Y coordinate of the upper left corner of the element Specified in pixels. Example: `‎10‎`.
“Width”	Specified in pixels. Example: `‎150‎`
“Height”	Specified in pixels. Example: `‎30‎`

You can also change the values by dragging the box symbols ( _visu_icon_position_element ) to other positions in the editor.

See also

⮫ “Positioning the Element, Adapting Size and Layer”

Element property 'Center'

The properties contain fixed values for the coordinates of the point of rotation. This point of rotation is shown as the symbol. The point is used as the center for rotating and scaling.

“X”	X-coordinate of the point of rotation
“Y”	Y-coordinate of the point of rotation

You can also change the values by dragging the symbols () to other positions in the editor.

Element property 'Colors'

The properties contain fixed values for setting colors.

“Color”	Color for the element in its normal state. Please note that the normal state is in effect if the expression in the “Color variables Toggle color” property is not defined or it has the value `‎FALSE‎`.
“Alarm color”	Color for the element in alarm state. Please note that the alarm state is in effect if the expression in the “Color variables Toggle color” property has the value `‎TRUE‎`.
“Transparency”	Value (0 to 255) for defining the transparency of the selected color. Example `‎255‎`: The color is opaque. `‎0‎`: The color is completely transparent.
“Use gradient color”	: The element is displayed with a color gradient.
“Gradient setting”	The “Color gradient editor” dialog box opens.

See also

Element property 'Image'

“Static ID”	Reference to an image in an image pool of the format <name of image pool>.<image ID> (example: `‎image_pool.GreenButton‎`). If the image is from the “GlobalImagePool”, then you can omit the name of the image pool because CODESYS always searches this pool first. : The “Input Assistant” dialog box opens and lists all available image pools and images in the entire project.
“Scale type”	Behavior of the image when resizing the button. “Isotropic”: The image retains its proportions. The ratio of height to width is retained, even if you change the height or width of the button separately. “Anisotropic”: The image resizes to the dimensions of the button. “Fixed”: The image retains its original size, even if you change the size of the button.
“Transparency”	The visualization displays the image with the transparency color that is selected in “Transparency color”.
“Transparency color”	Color that is transparent in the image (example: “White”). if the image background that is reference by “Static ID” is white, then this background is displayed transparent. Clicking opens a color selection dialog. Requirement: The “Transparency” option is activated.
“Horizontal alignment”	Horizontal alignment of the image “Left” “Centered” “Right”
“Vertical alignment”	Vertical alignment of the image “Top” “Centered” “Bottom”

Element property 'Texts'

The properties contains character strings for labeling the element. The character string can also contain a placeholder with a format definition. In runtime mode, the placeholder is replaced by the current value in the specified format.

CODESYS accepts the specified texts automatically into the “GlobalTextList” text list. Therefore, these texts can be localized.

“Text”

Character string (without single straight quotation marks) for the labeling the element. Add a line break by pressing the keyboard shortcut [Ctrl] + [Enter].

Example: ‎Accesses: %i‎

The variable that contains the current value for the placeholder is specified in the property “Text variable Text”.

“Tooltip”

Character string (without single straight quotation marks) that is displayed as the tooltip of an element.

Example: ‎Number of valid accesses‎.

The variable that contains the current value for the placeholder is specified in the property “Text variable Tooltip”.

See also

Element property 'Text properties'

The properties contain fixed values for the text properties.

“Horizontal alignment”	Horizontal alignment of the text within the element.
“Vertical alignment”	Vertical alignment of the text within the element.
“Text format”	Definition for displaying texts that are too long “Default”: The long text is truncated. “Line break”: The text is split into parts. “Ellipsis”: The visible text ends with "..." indicating that it is not complete.
“Font”	Example: “Default” : The “Font” dialog box opens. : Drop-down list with style fonts.
“Font color”	Example: “Black” : The “Color” dialog box opens. : Drop-down list with style colors.
“Transparency”	Whole number (value range from `‎0‎` to `‎255‎`). This determines the transparency of the respective color. Example: `‎255‎`: The color is opaque. `‎0‎`: The color is completely transparent. Please note: If the color is a style color and already has a transparency value, then this property is write-protected.

Element property 'Absolute movement'

The properties contain IEC variables for controlling the position of the element dynamically. The reference point is the upper left corner of the element. In runtime mode, the entire element is moved.

“Movement”
“X”	Variable (numeric data type). Defines the X position (in pixels). Example: `‎PLC_PRG.iPos_X‎`. Increasing this value in runtime mode moves the element to the right.
“Y”	Variable (numeric data type). Defines the Y position (in pixels). Example: `‎PLC_PRG.iPos_Y‎`. Increasing this value in runtime mode moves the element downwards.
“Rotation”	Variable (numeric data type). Defines the angle of rotation (in degrees). Example: `‎PLC_PRG.iAngle1‎`. The midpoint of the element rotates at the “Center” point. This rotation point is shown as the symbol. In runtime mode, the alignment of the element remains the same with respect to the coordinate system of the visualization. Increasing the value rotates the element to the right.
“Scaling”	Variable (integer data type). Causes centric stretching. Example: `‎PLC_PRG.iScaling‎`. The reference point is the “Center” property. The value `‎1‎` shrinks the element by a factor of `‎0.001‎`. The value `‎1000‎` returns the element to its original size.

You can link the variables to a unit conversion.

The properties “X”, “Y”, “Rotation”, and “Interior rotation” are supported by the "Client Animation" functionality.

See also

Element property 'Relative movement'

The properties contains variables for moving the element. The reference point is the position of the element (“Position” property). The shape of the element can change.

“Movement top-left”
“X”	Variable (integer data type). It contains the number (in pixels) that the left edge is moved horizontally. Incrementing the value moves the element to the right. Example: `‎PLC_PRG.iDeltaX‎`
“Y”	Variable (integer data type). It contains the number (in pixels) that the top edge is moved vertically. Incrementing the value moves the element to the down. Example: `‎PLC_PRG.iDeltaY‎`
“Movement bottom-right”
“X”	Variable (integer data type). It contains the number (in pixels) that the right edge is moved horizontally. Incrementing the value moves the element to the right. Example: `‎PLC_PRG.iDeltaWidth‎`
“Y”	Variable (integer data type). It contains the number (in pixels) that the bottom edge is moved vertically. Incrementing the value moves the element to the down. Example: `‎PLC_PRG.iDeltaHeight‎`

See also

⮫ “Element property 'Absolute movement'”

Element property 'Text variables'

These properties are variables with contents that replace a format definition.

“Text variable”

Variable (data type compliant with the format definition). It contains what is printed instead of the format definition.

Example: ‎PLC_PRG.iAccesses‎

Note: The format definition is part of the text in the property “Texts Text”.

Note: If you specify a variable of type enumeration with text list support, then the name of the enumeration data type is added automatically in angle brackets after the variable name. Example: ‎PLC_PRG.enVar <enumeration name>‎. Then the symbolic value of the enumeration component is printed instead of the numeric value when text is printed. Refer to the help page for the enumerations.

“Tooltip variable”

Variable (data type compliant with the format definition). It contains what is printed instead of the format definition.

Example: ‎PLC_PRG.iAccessesInTooltip‎

Note: The format definition is part of the text in the property “Texts Tooltip”.

See also

Element property 'Dynamic texts'

Dynamic texts are variably indexed texts of a text list. At runtime, the text is displayed that is currently indexed in the variable.

“Text list”

Variable (string) or name of the text list as a fixed string in single straight quotation marks.

Example: ‎'Errorlist'‎

_cds_icon_arrow_down : Drop-down list with the dialogs available in the text lists.

“Text index”

Text list ID. This refers to the desired output text.

As fixed string with the ID in single straight quotation marks.

Example: ‎'1'‎
As a variable (‎STRING‎) for dynamically controlling the text output.

Example: ‎strTextID‎

Sample assignment: ‎PLC_PRG.strTextID := '1';‎

“Tooltip index”

Text list ID. This refers to the desired output text.

As fixed string with the ID in single straight quotation marks.

Example: ‎'2'‎
As a variable (‎STRING‎) for dynamically controlling the text output.

Example: ‎strToolTipID‎

Sample assignment: ‎PLC_PRG.strToolTipID := '2';‎

See also

⮫ “Object 'Text List'”

Element property 'Font variables'

The variables allow for dynamic control of the text display.

“Font name”	Variable (`‎STRING‎`). Includes the font of the text. Example: `‎PLC_PRG.stFontVar := 'Arial';‎` The selection of fonts corresponds to the default “Font” dialog.
“Size”	Variable (numeric data type). Contains the font size (in pixels or points). The applied unit is specified in brackets after the variable name. <pt>: Points (default) Example: `‎PLC_PRG.iFontHeight <pt>‎` Code: `‎iFontHeight : INT := 12;‎` <px> : Pixels Example: `‎PLC_PRG.iFontHeight <px>‎` Code: `‎iFontHeight : INT := 19;‎` If you click in the value field, a drop-down list opens on the right for setting the unit. Hint: The font size is specified in points (example: Arial 12). Use points when the variable font size should match a font, for example if a font is set in the property “Text property Font”.
“Flags”	Variable (`‎DWORD‎`). Contains the flags for displaying fonts. Flags: `‎1‎`: Italics `‎ 2‎`: Bold `‎4‎`: Underline `‎8‎`: Strikethrough Note: You can combine the font displays by adding the coding of the flags. For example, a bold and underlined text: `‎PLC_PRG.dwFontType := 6;‎`
“Character set”	Variable (`‎DWORD‎`). Contains a character set number for the font. The selection of character set numbers corresponds to the “Script” setting of the standard “Font” dialog.
“Color”	Variable (`‎DWORD‎`). Includes the color of the text. Example: `‎PLC_PRG.dwColorFont:= 16#FF000000;‎`
“Flags for text alignment”	Variable (integer data type). Contains the coding for text alignment. Example: `‎PLC_PRG.dwTextAlignment‎`. Coding: `‎0‎`: Top left `‎1‎`: Horizontal center `‎2‎`: Right `‎4‎`: Vertical center `‎8‎`: Bottom Note: You can combine the text alignments by adding the coding of the flags. For example, a vertical and horizontal centered text: `‎PLC_PRG.dwFontType := 5;‎`

Fixed values for displaying texts are set in “Text properties”.

See also

⮫ “Element property 'Text properties'”

Element property 'Color variables'

The Element property is used as an interface for project variables to dynamically control colors at runtime.

“Toggle color”

The property controls the toggled color at runtime.

Value assignment:

‎FALSE‎: The element is displayed with the color specified in the “Color” property.
‎TRUE‎: The element is displayed with the color specified in the “Alarm color” property.

Assigning the property:

Placeholder for the user input variable
- “<toggle/tap variable>”
- “<NOT toggle/tap variable>”
The color change is not controlled by its own variable, but by a user input variable.

Note: Specify a variable for the mouse events “Tap” or “Toggle” in the input configuration of the element. Only then is the placeholder set. If you configure a variable in both “Toggle” and “Tap”, then the variable specified in “Tap” is used.

Hint: Click the symbol to insert the placeholder “<toggle/tap variable>”. When you activate the “Inputconfiguration”, “Tap FALSE” property, then the “<NOT toggle/tap variable>” placeholder is displayed.
Instance path of a project variable (‎BOOL‎)

Example: ‎PLC_PRG.xColorIsToggeled‎

Note: In the code, declare and implement the variable specified here. Its value assignment determines when the color changes.

“Color”

Color variable for the Frame

Variable (‎DWORD‎) for the color

Example: ‎PLC_PRG.dwColor‎
Color literal

Example of gray and opaque: ‎16#FF888888‎

Requirement: “Show Frame” property is activated.

Please note that the normal state is in effect if the expression in the “Colorvariables Toggle color” property is not defined or it has the value ‎FALSE‎.

“Alarm color”

Color variable for the Frame in alarm state

Variable (‎DWORD‎) for the alarm color

Example: ‎PLC_PRG.dwAlarmColor‎
Color literal

Example of red and opaque: ‎16#FFFF0000‎

Please note that the alarm state is in effect if the expression in the “Colorvariables Toggle color” property has the value ‎TRUE‎.

The transparency part of the color value is evaluated only if the “Activate semi-transparent drawing” option of the visualization manager is selected.

Select the “Advanced” option in the toolbar of the properties view. Then all element properties are visible.

See also

Element property 'State variables'

The variables control the element behavior dynamically.

“Invisible”

Variable (‎BOOL‎). Toggles the visibility of the element.

‎TRUE‎: The element is not visible at runtime.

Example: ‎bIsVisible‎ with ‎VAR bIsVisible : BOOL := FALSE; END_VAR‎

“Deactivate inputs”

Variable (‎BOOL‎). Toggles the operability of the element.

‎TRUE‎: User inputs do not have any effect in runtime more. The element is shown as deactivated.

The “Invisible” property is supported by the "Client Animation" functionality.

Element property 'Button state variable'

“Digital variable”

At runtime, the property controls whether the Button is displayed as pressed or not.

Values:

‎FALSE‎: The Button is displayed as not pressed.
‎TRUE‎: The Button is displayed as pressed.

Argument passed to the property:

Placeholder for the user input variable to couple the representation of the Button with the input variable.
- “<toggle/tap variable>”
- “<NOT toggle/tap variable>”
Note: Specify a variable for the mouse events “Tap” or “Toggle” in the input configuration of the Button. Only then is the placeholder set. If you configure a variable in both “Toggle” and “Tap”, then the variable specified in “Tap” is used.

Hint: Click the symbol to insert the placeholder “<toggle/tap variable>”. When you activate the “Inputconfiguration”, “Tap FALSE” property, then the “<NOT toggle/tap variable>” placeholder is displayed.
Instance path of a project variable (‎BOOL‎)

Example: ‎prgA.xButtonState‎

Note: Implement a value assignment in the code for the variable specified here.

Element property 'Image ID variable'

“Image ID”

Variable (‎STRING‎). Contains the image ID. The contents of the string corresponds to the description of the “Static ID” property.

Example: ‎PLC_PRG.stImageID := 'ImagePool_A.Image3';‎

See also

These properties are available only when you have selected the “Support client animations and overlay of native elements” option in the Visualization Manager.

“Animation duration”

Defines the duration (in milliseconds) in which the element runs an animation

Variable (‎integer value‎)

Example: ‎Menu.tContent‎ with ‎VAR tContent : INT := 500; END_VAR‎
Integer literal

Example: ‎500‎

Animatable properties

“Absolute movement”, “Movement”, “X”, “Y”
“Absolute movement”, “Rotation”
“Absolute movement”, “Interior rotation”
“Absolute movement”, “Exterior rotation”

The animated movement is executed when at least one value of an animatable property has changed. The movement then executed is not jerky, but is smooth within the specified animation duration. The visualization element travels to the specified position while rotating dynamically. The transitions are smooth.

“Move to foreground”

Moves the visualization element to the foreground

Variable (‎BOOL‎)

Example: ‎bIsInForeground‎ with ‎VAR bIsInForeground : BOOL := FALSE; END_VAR‎

‎TRUE‎: At runtime, the visualization element is displayed in the foreground.

‎FALSE‎: At runtime, the visualization element is displayed in the layer where it was inserted in the visualization editor.

Element property 'Input configuration'

The properties contain the configurations for the user input when using the mouse or keyboard. A user input defines an event and one or more actions that are executed when an event occurs.

The “Configure” button opens the “Input Configuration” dialog. There you can create or edit user inputs. Configured user inputs are listed below the events. They each include the action that is triggered and the setting in short form. Example: “Execute ST Code”: `‎PLC_PRG.i_x := 0;‎`
“OnDialogClosed”	Input event: The user closes the dialog.
“OnMouseClick”	Input event: The user clicks the mouse button completely in the element area. The mouse button is clicked and released.
“OnMouseDown”	Input event: The user clicks down on the mouse button.
“OnMouseEnter”	Input event: The user drags the mouse pointer to the element.
“OnMouseLeave”	Input event: The user drags the mouse pointer away from the element.
“OnMouseMove”	Input event: The user moves the mouse pointer over the element area.
“OnMouseUp”	Input events: The user releases the mouse button within the element area. It is irrelevant whether the user has previously pressed the mouse button inside or outside the element area. The user presses the mouse button within the element area, leaves the element area, and then releases the mouse button. Note: This CODESYS-specific triggering behavior guarantees that actions for key elements are completed. A key element starts an action for “OnMouseDown” and ends the action for “OnMouseUp”. Example: A visualization user presses the mouse button within the element area of the key element and then moves the cursor position so that it lies outside the element area. The action is ended anyway because “OnMouseUp” is triggered.

“Tap”	When a mouse click event occurs, the variable defined in “Variable” is described in the application. The coding depends on the “Tap FALSE” and “Tap on enter if captured” options.
“Variable”	Variable (`‎BOOL‎`) that is set on mouse click event. Example: `‎PLC_PRG.bIsTapped‎` `‎TRUE‎`: A mouse click event exists. It lasts as long as the user presses the mouse button over the element. It ends when the button is released. `‎FALSE‎`: A mouse click event does not exist. Requirement: The “Tap FALSE” option is not activated.
“Tap FALSE”	: The mouse click event leads to a complementary value in “Variable”. `‎TRUE‎`: A mouse click event does not exist. `‎FALSE‎`: While the mouse click event exists.
“Tap on enter if captured”	: During user input, it is also taken into consideration whether the mouse pointer is dragged within the element area or not while the mouse button is pressed. `‎TRUE‎`: While the mouse click event exists and the mouse pointer is moved over the element area. `‎FALSE‎`: A mouse click event does not exist. Or the user moves the mouse pointer outside of the element area while the mouse button is pressed. The value is `‎TRUE‎` again as soon as the user moves the pointer back to the element area. The mouse is then captured.

“Toggle”

With the onset of a mouse click event, the variable is set; when the mouse click event is completed, the variable is reset.

“Variable”

Variable (‎BOOL‎). Its value toggled when the mouse click event is ended. This is when the user releases the mouse button while the mouse pointer is over the element area.

If the user releases the mouse button while the mouse pointer is outside of the element area, then the mouse click event is not ended and the value is not toggled.

Hint: The user can cancel a started toggle input by dragging the mouse pointer out of the element area.

“Toggle on up if captured”

_cds_icon_option_activated : The value toggles regardless of where the mouse pointer is when the mouse button is released. The mouse is then captured.

“Hotkey”	Keyboard shortcut on the element for triggering specific input actions. When the keyboard shortcut event occurs, the input actions in the “Events” property are triggered. In this way, it is not the input action itself that leads to this input action, but the mouse input action.
“Key”	Key pressed for input action. Example: [T] Note: The following properties appear when a key is selected.
“Events”	“None” “Mouse down”: Pressing the key triggers the input actions that are configured in the “OnMouseDown” property. “Mouse up”: Releasing the key triggers the input actions that are configured in the “OnMouseUp” property. “Mouse down/up”: Pressing and releasing the key triggers the input actions that are configured in the “OnMouseDown” property and the “OnMouseUp” property.
“Shift”	: Combination with the Shift key Example: [Shift]+[T].
“Control”	: Combination with the Ctrl key Example: [Ctrl]+[T].
“Alt”	: Combination with the Alt key Example: [Alt]+[T].

All keyboard shortcuts and their actions that are configured in the visualization are listed on the “Keyboard Configuration” tab.

See also

Element property 'Access rights'

Requirement: User management is set up for the visualization.

“Access rights”

Opens the “Access rights” dialog. There you can edit the access privileges for the element.

Status messages:

“Not set. Full rights.”: Access rights for all user groups : “operable”
“Rights are set: Limited rights”: Access is restricted for at least one group.

See also

⮫ “Dialog 'Access Rights'”