Visualization Element: Combo Box, Array

Symbol:

Category: Common Controls

The element shows values of an array as a list box. When the visualization user clicks an entry, the array index of the entry is written to an integer variable.

Note

0_Sample_Project Sample project about list boxes in combination with arrays and text lists

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_Product_Number` Tip Assign individual names for elements so that they are found faster in the element list.
Element Type	Combo Box, Array

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 symbols to other positions in the editor.

Columns

The "Combo Box, Array" element displays an array variable or structure variable in a tabular view. The index of array elements or of structure members are displayed in a column or in a row. Two-dimensional arrays or arrays of a structure are shown in multiple columns. You specify the displayed variable in the Data array property. When a variable is assigned there, you can specify the display of the table columns where the array elements are shown. You can customize each column that is assigned to an index n.

Columns [<n>]	Due to the structure of the variable that is defined in Data array, the number of columns is determined automatically and they are defined with the index n. Example: Three columns `[0]`, `[1]`, and `[2]` are formed: `StringTable : ARRAY [0..2, 0..4] OF STRING := ['BMW','Audi','Mercedes','VW','Fiat', '150','150','150','150','100','blue','gray','silver','blue','red'];`
Max. array index	Optional Variable (integer data type) or value Defines up to which array index the data is displayed
Row height	Height of the rows (in pixels)
Count visible rows	Optional If the array is larger than the number of visible rows, then a scroll bar is included.
Scroll bar size	Width of the vertical scroll bar (in pixels)

Table 10. Columns: Column [<n>] Element Property

Width	Column width (in pixels)
Image column	: Images can be displayed in the column. Images are used from the global image pool or custom image pools. The image IDs are shown in the cells of the table as they are defined in the image pool.
Image configuration
Fill mode	Fill cell The image resizes to the dimensions of the cell without fixing the height/width ratio. Centered The image is centered in the cell and retains its proportions (height/width ratio).
Transparency	: The color which is specified in Transparent color is displayed as transparent.
Transparent color	When the Transparent property is enabled, the color specified here is not displayed. Pixels with this color are transparent.
Text alignment in column	Left Centered Right
Use template	: The array data is displayed in the table. : The table cells get additional properties (configurable per column), namely all those which have a rectangle. This gives a table cell the same range of functions as a rectangle. The additional properties are displayed under the Template property. Use case: In order to process user input (for example, clicking in a cell), this cell must have an input configuration. This is possible when the Use template option is activated. The Input configuration property is then available and a follow-up action can be configured for a mouse event. Example: When a user clicks on the cell configured in this way in the running visualization, the Boolean variable assigned to the cell is toggled.
Text alignment of the headline from the template	: The column label is created with the text properties from the template.
Template	When the Use template property is activated, this property is visible and all properties of a rectangle are available below it. Tip These properties and their options are described in the help for the Rectangle, Rounded Rectangle, Ellipse element.

Variable

Variable	The array index of the list entry that the user clicks is saved at runtime. Variable (integer data type) Example: `PLC_PRG.iIndexComboboxEntry`
Data array	Displayed as a combo box. Every array component becomes a combo box entry. Array variable (`ARRAY[...] OF`) Example: `PLC_PRG.astrCombobox` Declaration: `astrCombobox : ARRAY[0..4] OF STRING := ['First', 'Second', 'Third', 'Fourth'];`

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.

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: The values of the visualization style are used. Individual settings: The "Individual text properties" property group is shown The values can be customized there.
Individual text properties Requirement: The Individual settings text property is defined.
Font	Example: Default : The Font dialog opens. : List box with style fonts
Font color	Font color in the normal state Example: Black : The Color dialog opens. : List box with style colors
Font alarm color	Font color which is active in the alarm state Important It must differ from the font color in the normal state. Example: Red
Transparency	Integer (value range from `0` to `255`). This 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 symbol and is used as the center for rotation and scaling. Tip You can also change the values by dragging the 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` Container variable: `Container.Width` For more information, see the following: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element to the right.
Y	Variable (numeric data type) for the Y-position (in pixels) Example: `PLC_PRG.iPos_Y` Container variable: `Container.Height` For more information, see the following: Optimally Adjusting the Position and Size 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 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.
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 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.

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.

Visualization Element: Combo Box, Array

Note

Element properties

Are all element properties available?

Tip

Position

Tip

Columns

Tip

Variable

Texts

Tip

Tip

Text properties

Important

Note

State variables

Tip

Center

Tip

Absolute movement

Note

Tip

Tip

Animation

Tip

Input Configuration

Tip

Permissions

Note