Combobox

A combo box is a drop-down menu for selecting an option from several options. Each option is defined by its ID and also has a text that is displayed in the drop-down menu, and an assigned value.

Note that the dropdown menu for the size of the control will be added to this. This becomes relevant for the topic Overfill with small containers.

A description of the configuration can be found in chapter Configuration.

Attributes

Category: Colors

Name

Description

TextColor

Definition of the text color

DropDownTextColor

Definition of the text color in the drop-down list

DropDownBackgroundColor

Definition of the background color of the drop-down list

DropDownHighlightColor

Definition of the highlight color of the background of a selected entry in the drop-down list

DropDownHighlightTextColor

Definition of the highlight color of the text of a selected entry in the drop-down list

DropDownToggleButtonBackgroundColor

Definition of the color of the button to expand the drop-down list

DropDownToggleButtonArrowColor

Definition of the color of the arrow of the button to expand the drop-down list

BackgroundColor

Definition of the background color

BorderColor

Definition of the border color of the control

Category: Layout

Name

Description

Left

Definition of the distance from the left side to the left side of the surrounding control

LeftUnit

Definition of the unit of the distance to the right side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Top

Definition of the distance from the top side to the top side of the surrounding control

TopUnit

Selection of the unit of the distance to the top side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Right

Definition of the distance from the right side to the right side of the surrounding control

RightUnit

Selection of the unit of the distance to the right side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Bottom

Definition of the distance from the bottom side to the bottom side of the surrounding control

BottomUnit

Selection of the unit of the distance to the bottom side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Width

Definition of the external width of the control

WidthUnit

Selection of the unit of the width:

  • Pixels for an absolute width
  • Percent for a relative width

Height

Definition of the external height of the control

HeightUnit

Selection of the unit of the height:

  • Pixels for an absolute height
  • Percent for a relative height

MaxWidth

Definition of the maximum width if the control size is defined as dynamic.

MaxWidthUnit

Selection of the unit of the maximum width:

  • Pixels for an absolute value
  • Percent for a relative value

MinWidth

Definition of the minimum width if the control size is defined as dynamic.

MinWidthUnit

Selection of the unit of the minimum width:

  • Pixels for an absolute value
  • Percent for a relative value

MaxHeight

Definition of the maximum height if the control size is defined as dynamic.

MaxHeightUnit

Selection of the unit of the maximum height:

  • Pixels for an absolute value
  • Percent for a relative value

MinHeight

Definition of the minimum height if the control size is defined as dynamic.

MinHeightUnit

Selection of the unit of the minimum height:

  • Pixels for an absolute value
  • Percent for a relative value

RenderedLeft

Calculated distance in pixels from the left side to the left side of the surrounding control

RenderedTop

Calculated distance in pixels from the top side to the top side of the surrounding control

RenderedRight

Calculated distance in pixels from the right side to the right side of the surrounding control

RenderedBottom

Calculated distance in pixels from the bottom side to the bottom side of the surrounding control

RenderedWidth

Calculated width of the control in pixels

RenderedHeight

Calculated height of the control in pixels

GridRowIndex

Definition of the row of a grid in which the control is to be displayed.

GridColumnIndex

Definition of the column of a grid in which the control is to be displayed.

Opacity

Definition of the transparency of the entire control

Visibility

Selection of the visibility of a control:

  • Visible: Control is visible.
  • Hidden: Control is invisible, but is drawn – controls behind it cannot be operated.
  • Collapsed: Control is invisible and is not drawn – controls behind it can be operated.

ZIndex

Definition of the position on the Z-axis

Transform

Definition of a transformation of a control:

  • Translate: Translate in X-, Y-, Z-direction
  • Rotate: Rotate by an angle
  • Scale: Zoom by a factor
  • Skew: Sides shown skewed by an angle
  • Origin: Set the origin of the transformation relative to the position of the control
  • Perspective: Set the perspective of the transformations of all child elements

BoxShadow

Definition of a shadow

 

 

WidthMode

Selection of the method of calculating the width:

  • Value: The width is defined by the width entered.
  • Parent: The width is defined by the distance to the left and right side of the parent element. The "Width" attribute is ignored in all calculations!

HeightMode

Selection of the method of calculating the height:

  • Value: The height is defined by the height entered.
  • Parent: The height is defined by the distance to the top and bottom side of the parent element. The "Height" attribute is ignored in all calculations!

Category: Common

Name

Description

IsEnabled

Selection of whether a control should be activated

Id

Definition of the name of the control

Type

Type name of the control

ClassNames

Definition of control classes

IsAttached

If a control is logically assigned in the DOM.

Tooltip

Definition of the tooltip for the control

Category: Border

Name

Description

BorderRadius

Definition of the radius of the four corners to round them off

BorderStyle

Selection of the border style of the four sides of the control

BorderWidth

Definition of the border width of the four sides of the control

Category: Background Image

Name

Description

BackgroundImage

Definition of an image that is located above the background color

BackgroundImageHeight

Definition of the height of the background image

BackgroundImageHeightUnit

Selection of the unit of the height of the background image:

  • Pixels for an absolute height
  • Percent for a relative height

BackgroundImageWidth

Definition of the width of the background image

BackgroundImageWidthUnit

Selection of the unit of the width of the background image:

  • Pixels for an absolute width
  • Percent for a relative width

BackgroundImagePadding

Definition of an additional distance between the border of the control and background image for the four sides

BackgroundImageVerticalAlignment

Definition of the vertical alignment of the background image within the control

BackgroundImageHorizontalAlignment

Definition of the horizontal alignment of the background image within the control

Category: Data

Name

Description

SrcData

Definition of data for the list entries

EnumDataSymbol

Definition of the data for the list entries in the form of a symbol of the type of an enumeration.

Text

Definition of the text that is displayed if free text entry is allowed

AllowTextInput

Definition as to whether free text entry is to be allowed

ComboboxText

Definition of the text that is displayed if no entry is selected

SelectedIndex

Definition of the selected entry via its index. The first entry in a drop-down list starts at index 0.

ContentPadding

Defines the distance of the text to the border.

Category: Text

Name

Description

TextFontFamily

Definition of the font using the name of the font family or the keyword

TextFontSize

Definition of the font size

TextFontSizeUnit

Selecting the font size unit

  • Pixels for an absolute size
  • Percent for a relative size

TextFontStyle

Selecting the font style:

  • Normal
  • Italic
  • Oblique

TextFontWeight

Selecting the font weight

  • Normal
  • Bold

TextHorizontalAlignment

Selecting the horizontal alignment of the text

TextVerticalAlignment (Only in product version 1.8)

Definition of the vertical alignment of the text

Category: DropDown

Name

Description

DropDownHorizontalAlignment

Selecting the horizontal alignment of the text in the drop-down list

DropDownVerticalAlignment

Selecting the vertical alignment of the text in the drop-down list

DataHeight

Definition of the height of the entries in the drop-down menu

DataHeightUnit

Selecting the unit of the height of the list items

  • Pixels for an absolute height
  • Percent for a relative height

List Height

Definition of the maximum height of the drop-down list

List Height Unit

Selecting the unit of the drop-down list height

DropDownFontFamily

Definition of the font of the list items via the name of the font family or the keyword

DropDownFontSize

Definition of the font size of the list items

DropDownFontSizeUnit

Selecting the font size unit

  • Pixels for an absolute size
  • Percent for a relative size

DropDownFontStyle

Selecting the font style:

  • Normal
  • Italic: italic
  • Oblique: slanted

DropDownFontWeight

Selecting the font weight of the text entries:

  • Normal
  • Bold: Bold

DropDownVerticalAlignment

Selecting the vertical alignment of the text in the drop-down list

DropDownStyle

Defines the position of the drop-down menu

Events

Category: Framework

Name

Description

onAttached

The control was added to the display.

onDetached

The control was removed from the display.

onInitialized

The control was initialized.

onDestroyed

The control was destroyed.

onMoved

The control was moved in relation to the browser window.

onResized

The size of the control was changed.

Category: Operator

Name

Description

onSelectionChanged

An entry has been selected.

onPressed

A mouse click was executed or a touch screen was briefly touched.

onMouseClick

The left mouse button was clicked over the control and released.

onMouseDoubleClick

The left mouse button was clicked twice over the control and released.

onMouseRightClick

The right mouse button was clicked over the control and released.

onMouseDown

A mouse button was pressed down over the control.

onMouseEnter

The mouse pointer was moved over the control.

onMouseLeave

The mouse pointer has left the control.

onMouseUp

A mouse button was released over the control.

onMouseDownLeft

The left mouse button was pressed down over the control.

onMouseDownRight

The right mouse button was pressed down over the control.

onMouseMove

The mouse was moved over the control.

onMouseOver

The mouse pointer was moved over the control or one of its children.

onMouseOut

The mouse pointer has left the control or one of its child controls.

onMouseUpLeft

The left mouse button was released over the control.

onMouseUpRight

The right mouse button was released over the control.

onMouseWheel

The mouse wheel was moved over the control.

onTouchStart

A finger/stylus was placed against a touch screen.

onTouchMove

A finger/stylus was moved on a touch screen.

onTouchEnd

A finger/stylus was lifted off a touch screen.

onTouchCancel

An interaction with a touch screen was aborted.

Access rights

Name

Description

observe

Determines whether the control is generally observable.

operate

Determines whether the control is generally operable.

Inheritance hierarchy

Control

    Combo box

NuGet package: Beckhoff.TwinCAT.HMI.Controls

Combobox 1:

NuGet packages are available from version 1.12.

Combobox 2:

Available from 1.8

See also

API reference for this control