Visualization Element 'Scrollbar'
Tag: Common controls
The element sets the value of a variable, depending on the position of the scrollbar.
Element name |
Example: Speed Conveyor Belt 1 Optional Hint: Assign individual names for elements so that they are found faster in the element list. |
Type of element |
Scrollbar |
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 |
Note
You can also change the values by dragging the symbols () to other positions in the editor.
Value |
Variable as type integer that includes the position of the scrollbar. |
Minimum value |
Smallest value of the scrollbar (fixed value or variable). |
Maximum value |
Largest value of the scrollbar (fixed value or variable). |
Page size |
Page size
Requirement: Visible when the Move to click property is not selected. |
Move to click |
Behavior of the scrollbar at visualization runtime when it is clicked:
|
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 |
Note
You can also change the values by dragging the box symbols () to other positions in the editor.
See also
The property defines the representation of scaling and direction of travel.
Orientation |
Alignment of the slider; defined by the ratio of width to height.
You can modify the alignment in the visualization editor by using the pointing device to adjust the width and height of the scrollbar. |
Running direction |
The drop-down list varies depending on the alignment of the slider. Horizontal
Vertical
|
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. |
See also
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. |
Font |
Example: Default
|
Font color |
Example: Black
|
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 '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'
|
Text index |
Text list ID. This refers to the desired output text.
|
Tooltip index |
Text list ID. This refers to the desired output text.
|
See also
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.
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:
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:
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; |
Note
Fixed values for displaying texts are set in Text properties.
See also
Element property 'Colorvariables'
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:
Assignment options:
|
Normal state Alarm state |
The properties listed below control the color depending on the state. The normal state is in effect if the variable in Color variables, Toggle color is not defined or it has the value FALSE. The alarm state is in effect if the variable in Colorvariables, Toggle color has the value TRUE. |
Frame color |
Assignment options:
|
Filling color |
Assignment options:
|
Note
The transparency part of the color value is evaluated only if the Activate semi-transparent drawing option of the visualization manager is selected.
Note
Select the Advanced option in the toolbar of the properties view. Then all element properties are visible.
See also
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 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. |
|
Interior rotation |
Variable (numeric data type). Defines the angle of rotation (in degrees). Example: PLC_PRG.iAngle2. In runtime mode, the element rotates about the point of rotation specified in Center according to the value of the variable. In addition, the alignment of the element rotates according to the coordinate system of the visualization. Increasing the value in the code rotates clockwise.
The rotation point is shown as the Note: If a static angle of rotation is specified in the Position ‣ Angle property, then the static angle of rotation is added to the variable angle of rotation (offset) when the visualization is executed. |
|
Note
You can link the variables to a unit conversion.
Note
The X, Y, Rotation, and Interior rotation properties are supported by the "Client Animation" functionality.
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. |
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. |
Note
The Invisible property is supported by the "Client Animation" functionality.
See also
These properties are available only when you select the Preview: Support client animations and overlay of native elements option in the Visualization Manager.
You can animate a movement, a rotation, and the visibility of a visualization element.
Animation time |
Time that the element executes an animation (in milliseconds) Example: 500 |
Move to the foreground |
Property value (BOOL) TRUE: At runtime, the element is displayed in the foreground. FALSE: At runtime, the element is displayed in the layer where it was inserted in the visualization editor. |
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:
|
See also