Keyboard

A keyboard is an on-screen keyboard that can be used for input without a hardware keyboard.

The Layout attribute can be used to select different layouts.

Version 1.12

From version 1.12 keyboard layouts are added to the TwinCAT HMI project via a wizard and can then be used via the attribute LayoutFile.

The attribute Layout is considered obsolete and should no longer be used.

See also: Configuration guide

Attributes

Category: Colors

Name	Description
LabelColor	Definition of the text color of the keys
LabelStrokeColor	Definition of the outline color of the graphic key characters
LabelFillColor	Definition of the fill color of the graphic key characters
KeyBackgroundColor	Definition of the background color of the keys
AdditionalKeyBackdropColor	Definition of the background color of the window in which the additional characters for the compact layouts are displayed
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
KeyboardPadding	Definition of the inner distance of the keypad to the outer sides of the keyboard
AdditionalKeyBackdropPadding	Definition of the inner distance of the additional keys to the outer sides of the window in which they are displayed
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
LayoutFile	Activates a layout from the project.
Layout	Selection of the keyboard layout
ScaleMode	Selecting the scaling of the keys
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: Behavior

Name	Description
FixedTarget	Definition of a control using its name, to which all input is sent regardless of the focus The name of the control must be entered as a simple string. The control must not be linked directly.
ReleaseStickyKeysManually	Selecting whether the Shift key must be deactivated manually after it has been used together with another key
LongpressDelay	Definition of the time in milliseconds that a key must be pressed for a long keystroke to be detected.
RepetitionDelay	Definition of the time in milliseconds that a key must be pressed for the input to be repeated.
PressedKeys

Category: Labels

Name	Description
LabelStrokeThickness	Definition of the stroke thickness of the graphic key characters
LabelFontFamily	Definition of the font using the name of the font family or the keyword
LabelFontSize	Definition of the font size of the key text
LabelFontSizeUnit	Selecting the unit of the text size: Pixels for an absolute size Percent for a relative size
LabelFontStyle	Selecting the font style: Normal Italic: italic Oblique: slanted
LabelFontWeight	Selecting the font weight: Normal Bold: bold

Category: Indirect Input

Name	Description
IndirectInputHorizontalAlignment	Defines the horizontal alignment of the text in the preview field for indirect input.
IndirectInputFontSize	Defines the font size of the text in the preview field for indirect input.
IndirectInputFonzSIzeUnit	Defines the font size unit of the text in the preview field for indirect input.
IndirectInputPadding	Defines the padding of the text in the preview field for indirect input.

Events

Category: Control

Name	Description
onKeyPressStarted	Interaction with a key was started.
onKeyPressFinished	Interaction with a key was finished.
onKeyPressCanceled	Interaction with a key was cancelled.
onKeyPressEnded	Interaction with a key was canceled or finished.
onIndirectInputAccepted	The user has confirmed the indirect entry.
onIndirectInputCanceled	The user has canceled the indirect input.

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

Keyboard

NuGet package: Beckhoff.TwinCAT.HMI.Controls

	NuGet packages are available from version 1.12.

	Available from 1.8