Skip to main content

Visualization Element: Combo Box, Integer

Symbol:

_visu_img_combobox_integer.png

Category: Common Controls

The element shows values as a list box. When the user clicks an entry, the ID of the entry is written to an integer variable. The entries in the list box can be from a list and contain images from an image pool.

Element properties

Are all element properties available?

All properties are available only after you select the Advanced option or the All categories filter in Properties.

Element name

Example: List of product numbers

Tip

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

Element Type

Combo Box, Integer

Position

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

X

The X-coordinate (in pixels) of the upper left corner of the element

Example: 10

Y

The Y-coordinate (in pixels) of the upper left corner of the element

Example: 10

Width

Specified in pixels

Example: 150

Height

Specified in pixels

Example: 30

Tip

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

Variable

Variable

Variable to be edited via the combo box

To display texts matching a list, a corresponding text list must also be configured.

When an enumeration with text list support is used, no additional text list needs to be configured.

  • Variable (integer data type). Only numeric IDs are allowed .

    Example:

    PLC_PRG.iIDComboboxEntry

    PLC_PRG.eStateTrafficLight (see example below ”TrafficLight“)

  • Enumeration variable with text list support

    Example: PLC_PRG.eMyCombobox

    After the selection of the enumeration variable, the data type is supplemented automatically.

Text List

Name of the text list whose entries are displayed in the expanded combo box.

A maximum of 32766 entries can be displayed.

  • Text list identifier as string

    Example:

    'TextList_A'

    'TrafficLight' (see TrafficLight example below)

    The IDs of the text list have to be within the value range of DWORD or DINT.

  • Blank

    • When an enumeration variable with text list support is specified in the Variable property

    • When only one image pool is displayed

Image Pool

Name of the image pool whose images are displayed as an entry in a combo box

Example: 'ImagePool_A'

Example 28. Example

TrafficLight

_visu_combobox_integer_properties_example.png


Settings of the list

Displayed list that expands when a visualization user clicks into the element.

Number of rows setting

  • From style:

  • Explicit: Then the Number of visible rows property appears below it.

Count visible rows

Number of visible lines of the combo box list defined here

  • Integer literal

    Example: 5

  • Variable (integer data type)

    Example: PLC_PRG.iNumberOfVisibleRows

Note

The property is available only when the Number of rows setting property is set to Explicit.

Row height

  • From style:

  • Literal

    Example: 20

Height of image

Image height (in pixels) of the image displayed in the list box entry

  • From style:

  • Integer literal

    Example: 30

Note

Images are displayed only when a value is specified in the Image pool property.

Width of image

Image width (in pixels) of the image displayed in the list box entry

  • From style:

  • Literal

    Example: 30

Note

Images are displayed only when a value is specified in the Image pool property.

Offset of image

Makes the images in the list box appear offset (in pixels) from the left margin.

An offset of 0 means that the images are displayed directly on the margin.

  • From style:

  • Literal

    Example: 4

Note

Images are displayed only when a value is specified in the Image pool property.

Scroll bar size

Size of the scroll bar (in pixels)

The scroll bar is displayed when more entries are specified in the list box than in Number of visible rows.

Default: 20

Texts

Tooltip

String (without single straight quotation marks)

Example: Products of customer A

The text is output as a tooltip. If a placeholder %<format string> is specified in the text, then the value of the variable in the Text variable → Tooltip property is output at the location of the placeholder.

Tip

Use the Ctrl+Enter shortcut to add a line break.

Tip

The specified texts are automatically transferred to the GlobalTextList text list. Therefore, these texts can be localized.

Value range

Limit valuerange

Requirement: A value is specified in the Text list property.

standard icon: Only the subrange that is defined by the Minimum value Maximum value properties is displayed as a list box.

Limits the text list to one subrange. This subrange is displayed by the combo box.

Minimum value

ID of the text list entry from which a combo box entry is displayed

  • Literal (ANY_NUM)

    Example: 5

  • Variable (integer data type)

    Example: PLC_PRG.iFirstEntry

Maximum value

ID of the text list entry up to which combo box entries are displayed

  • Literal (ANY_NUM)

    Example: 10

  • Variable (integer data type)

    Example: PLC_PRG.iLastEntry

Filter missing textentries

Requirement: A value is specified in the Text list property.

standard icon: Text list is refreshed and any unused texts (IDs) are removed.

Text properties

The properties get fixed values for the text properties and act on the texts configured in Texts → Text or Texts → Tooltip.

Usage of

  • Default style values, then the values of the visualization style are accepted

  • Individual settings

    The Individual text properties property group is shown. The values can be customized here.

Individual 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

_cds_icon_three_dots.png: The Font dialog opens.

_cds_icon_arrow_down.png: List box with style fonts

Font color

Example: Black

_cds_icon_three_dots.png: The Color dialog opens.

_cds_icon_arrow_down.png: List box with style colors

Transparency

Integer (value range from 0 to 255)

The transparent value determines the transparency of the respective color.

255: The color is opaque.

0: The color is completely transparent.

Note

If the color is a style color and already has a transparency value, then this property is write-protected.

State variables

The variables control the element behavior dynamically.

Invisible

Variable (BOOL) for toggling 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) for toggling the operability of the element

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

Tip

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

Center

The properties contain fixed values for the coordinates of the point of rotation. The rotation point is displayed in the editor as the _visu_icon_center_point.png symbol and is used as the center for rotation and scaling.

Tip

You can also change the values by dragging the _visu_icon_center_point.png symbol to another position in the editor.

X

X-coordinate of the point of rotation

Y

Y-coordinate of the point of rotation

Absolute movement

The properties can be assigned to IEC variables for controlling the position of the element dynamically. The reference point is the upper left corner of the element. At runtime, the entire element is moved.

Movement

X

  • Variable (numeric data type) for the X-position (in pixels)

    Example: PLC_PRG.iPos_X

Increasing this value at runtime moves the element to the right.

Y

Increasing this value at runtime moves the element downwards.

Rotation

Variable (numeric data type) for 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 _visu_icon_center_point.png symbol.

At runtime, 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.

_visu_img_prp_rotation.png

Interior rotation

Variable (numeric data type) for the angle of rotation (in degrees)

Example: PLC_PRG.iAngle2

At runtime, 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 _visu_icon_center_point.png 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.

_visu_img_prp_inner_rotation.png

Tip

You can combine the variables to a Unit conversion.

Tip

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

Animation

Tip

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

Variable for 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

Variable (BOOL) for setting the element in the foreground

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.

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

Input Configuration

Tip

The Configure button opens the Input Configuration dialog. There you can assign follow-up actions to the event.

OnValueChanged

Event which triggers follow-up actions due to a change in value

Which follow-up actions are triggered is configured in the Input Configuration dialog.

The defined follow-up actions and the corresponding configuration are displayed below the element property.

The OnValueChanged event can be disabled by the VISU_NO_VALUECHANGED compiler define in the properties dialog of the application.

Permissions

Note

Available only when a user management is set up for visualization.

Access Rights button

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.

: