Visualization Element 'Scroll Bar'

Symbol:

Tag: Common Controls

The element sets the value of a variable, depending on the position of the scroll bar.

Element properties

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

Scroll Bar

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

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

Minimum value

Smallest value of the scroll bar (fixed value or variable).

Maximum value

Largest value of the scroll bar (fixed value or variable).

Page size

Page size

  • As a fixed value, for example 10

  • As a variable of data type integer

Requirement: Visible when the Move to click property is not selected.

Move to click

Behavior of the scroll bar 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

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

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

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.

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

: 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

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;

Note

Fixed values for displaying texts are set in Text properties.

See also

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.

Assignment options:

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

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:

  • Variable (DWORD) for the frame color

    Example: PLC_PRG.dwBorderColor

  • Color literal

    Example of green and opaque: 16#FF00FF00

Filling color

Assignment options:

  • Variable (DWORD) for the fill color

    Example: PLC_PRG.dwFillColor

  • Color literal

    Example of gray and opaque: 16#FF888888

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

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

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.

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.

Note

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

See also

These properties are available only when you have selected the Preview: 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.

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

See also

3.5.16.0

© Copyright 2021, CODESYS GmbH