User Control
A user control is a reusable collection of controls which, after creation, is available in the toolbox like a standard control. The context menu option Add new Item… can be used to create a user control within the project tree.
![]() | When a User Control is added, a User Control Host is created that points to the User Control. Therefore, every change to an attribute (for example the background color) acts from the outside on the user control host and from the inside on the user control. |
Attributes
Category: Colors
Name |
Description |
---|---|
Definition of the background color | |
Definition of the border color of the control |
Category: Layout
Name |
Description |
---|---|
Definition of the distance from the left side to the left side of the surrounding control | |
Definition of the unit of the distance to the right side of the surrounding control:
| |
Definition of the distance from the top side to the top side of the surrounding control | |
Selection of the unit of the distance to the top side of the surrounding control:
| |
Definition of the distance from the right side to the right side of the surrounding control | |
Selection of the unit of the distance to the right side of the surrounding control:
| |
Definition of the distance from the bottom side to the bottom side of the surrounding control | |
Selection of the unit of the distance to the bottom side of the surrounding control:
| |
Definition of the external width of the control | |
Selection of the unit of the width:
| |
Definition of the external height of the control | |
Selection of the unit of the height:
| |
Definition of the maximum width if the control size is defined as dynamic | |
Selection of the unit of the maximum width:
| |
Definition of the minimum width if the control size is defined as dynamic | |
Selection of the unit of the minimum width:
| |
Definition of the maximum height if the control size is defined as dynamic | |
Selection of the unit of the maximum height:
| |
Definition of the minimum height if the control size is defined as dynamic | |
Selection of the unit of the minimum height:
| |
Calculated distance in pixels from the left side to the left side of the surrounding control | |
Calculated distance in pixels from the top side to the top side of the surrounding control | |
Calculated distance in pixels from the right side to the right side of the surrounding control | |
Calculated distance in pixels from the bottom side to the bottom side of the surrounding control | |
Calculated width of the control in pixels | |
Calculated height of the control in pixels | |
Definition of the row of a grid in which the control is to be displayed | |
Definition of the column of a grid in which the control is to be displayed | |
Definition of the transparency of the entire control | |
Selection of the visibility of a control:
| |
Definition of the position on the Z-axis | |
Definition of a transformation of a control:
| |
Definition of a shadow | |
Selection of the method of calculating the width:
| |
Selection of the method of calculating the height:
|
Category: Common
Name |
Description |
---|---|
Selection of whether the control is enabled | |
Definition of the name of the control | |
Type name of the control | |
Definition of control classes | |
If a control is logically assigned in the DOM. | |
Definition of the tooltip for the control |
Category: Border
Name |
Description |
---|---|
Definition of the radius of the four corners to round them off | |
Selection of the border style of the four sides of the control | |
Definition of the border width of the four sides of the control |
Category: Background Image
Name |
Description |
---|---|
Definition of an image that is located above the background color | |
Definition of the height of the background image | |
Selection of the unit of the height of the background image:
| |
Definition of the width of the background image | |
Selection of the unit of the width of the background image:
| |
Definition of an additional distance between the border of the control and background image for the four sides | |
Definition of the vertical alignment of the background image within the control | |
Definition of the horizontal alignment of the background image within the control |
Events
Category: Framework
Name |
Description |
---|---|
The control was added to the display. | |
The control was removed from the display. | |
The control was initialized. | |
The control was destroyed. | |
The control was moved in relation to the browser window. | |
The size of the control was changed. |
Category: Operator
Name |
Description |
---|---|
A mouse click was executed or a touch screen was briefly touched. | |
The left mouse button was clicked over the control and released. | |
The left mouse button was clicked twice over the control and released. | |
The right mouse button was clicked over the control and released. | |
A mouse button was pressed down over the control. | |
The mouse pointer was moved over the control. | |
The mouse pointer has left the control. | |
A mouse button was released over the control. | |
The left mouse button was pressed down over the control. | |
The right mouse button was pressed down over the control. | |
The mouse was moved over the control. | |
The mouse pointer was moved over the control or one of its children. | |
The mouse pointer has left the control or one of its child controls. | |
The left mouse button was released over the control. | |
The right mouse button was released over the control. | |
The mouse wheel was moved over the control. | |
A finger/stylus was placed against a touch screen. | |
A finger/stylus was moved on a touch screen. | |
A finger/stylus was lifted off a touch screen. | |
An interaction with a touch screen was aborted. |
Access rights
Name |
Description |
---|---|
Determines whether the control is generally observable. | |
Determines whether the control is generally operable. |
Inheritance hierarchy
User Control
NuGet package: Beckhoff.TwinCAT.HMI.Framework
![]() | NuGet packages are available from version 1.12. |
![]() | Available from version 1.10 |
See also
API reference for this control