Visualization Element ‘Scrollbar’

Symbol:

Tag: Common controls

This element sets the value of a variable, depending on the position of the scrollbar.

Element properties

Element name	Optional Tip: Assign individual names for elements so that they are found faster in the element list. Example: Speed_Conveyor_1
Element type	Scrollbar
Value	IEC variable as type integer that includes the position of the scroll box in the scroll bar.
Minimum value	Least value of the scrollbar (fixed value or variable).
Maximum value	Greatest value of the scrollbar (fixed value or variable).
Page size	Page size as a fixed value, for example 10 as an IEC variable of data type integer Clicking for more options ( ) opens the input assistance. Requirement: Visible when the Move to click property is not selected.
Move to click	Function of the scrollbar at visualization runtime when it is clicked: : The scrollbar moves to the clicked position. : The scrollbar moves to one Page size in the direction of the click.

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

Note

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

See also

• Positioning Elements, Adapting Size and Layer

Element property ‘Bar’

The property defines the representation of scaling and direction of travel.

Orientation	Alignment of the slider; defined by the ratio of width to height. Horizontal Vertical 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 Left to right: Scale starts at the left. Right to left: Scale starts at the right. Vertical Bottom to top: Scale starts at the bottom. Top to bottom: Scale starts at the top.

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.

See also

• Designing Visualizations with Elements

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. 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

• <no title>
• Designing Visualizations with Elements
• Placeholders with Format Definition in the Output Text

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 : 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 ‘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 <myEnum>. 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 DUT object.

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

• Placeholders with Format Definition in the Output Text
• <no title>
• Unit Conversion: Unit Conversion

Element property ‘Dynamic texts’

The properties contain references to the texts of a text list.

Text list	Variable (string) or name of the text list as a fixed string in single straight quotation marks. Example: 'Errorlist' : 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

• Text list: Textlist

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 box.
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. Tip: 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 box.
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;

Note

Fixed values for displaying texts are set in Text properties.

See also

• <no title>

Element properties ‘Color variables’

The properties contains variables for dynamically controlling variables.

Toggle color	Dynamic control of toggle color With variable (BOOL) Example: prgA.bIsAlarm FALSE: Element is displayed with the color defined in the Color property. TRUE: Element is displayed with the color defined in the Alarm color property. With placeholder <toggle/tap variable> Then the toggle color is no longer controlled with a separate variable, but the an existing variable provided as a control variable of the property Input configuration ‣ Tap or the property Input configuration ‣ Toggle. Requirement: A variable is assigned in one of these properties. If a variable is assigned in both properties, then the variable in Input configuration ‣ Tap used. You can remove the placeholder by selecting it and pressing Del. Then the symbol appears in the value field. : Click the command icon to insert the placeholder <toggle/tap variable>.
Normal state	The normal state is in effect if the variable in Color variables ‣ Toggle color is not defined or it has the value FALSE.
Frame color	Variable (DWORD) for the frame color Example: PLC_PRG.dwBorderColor
Fill color	Variable (DWORD) for the fill color Example: PLC_PRG.dwFillColor
Alarm state	The alarm state is in effect if the variable in Color variables ‣ Toggle color has the value TRUE.

See also

• Animating a Color Display

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.

See also

• Designing Visualizations with Elements