TcHmi

[ Namespace ]

Namespaces

Name	Description
System	Provides resources for internal use. Resources under System are not intended for use by the user.
Controls	Provides resources for managing controls and the control resources themselves.
Callback	Provides resources for safely calling callback functions.
Functions	Provides resources for managing functions.
IFunctions	Provides data types for managing functions.
Log	Provides log functions.
Trigger	Provides interfaces, types and functions used in a trigger definition
IFunction	Provides interfaces, types and functions used in an IFunction definition.

Classes

Name	Description
Access	Provides functions for checking control-specific access rights.
Animation	Allows you to create and configure animations that can be played using CSS or JavaScript.
Base64BinaryReader	Allows reading binary data from a Base64-encoded string.
Base64BinaryWriter	Allows writing of binary data to a Base64-encoded string.
Binding	Provides functions for managing control attribute bindings.
ControlFactory	Class for creating control instances.
Environment	Provides environment information.
EventProvider	Provides functions for managing events.
Function	Used to execute functions based on a static JSON description.
Locale	Provides functions for managing the current system localization.
Localization	Provides localization functions.
Server	Provides functions for communication with the TwinCAT HMI Server.
StyleProvider	Provides functions for manipulating HTML elements in controls.
Symbol	Provides functions for accessing TwinCAT HMI framework symbols.
SymbolExpression	Symbol expression parser.
Theme	Provides functions for managing and changing themes.
TopMostLayer	Provides functions for an overlay area above the normal visualization.
ValueConverter	Provides functions for converting data types.
View	Provides functions for managing the view level.
Type	Type definitions

Functions

Name	Description
isSolidColor	Checks if a value is a SolidColor.
isLinearGradientColor	Checks whether a value is a LinearGradientColor.

Enumerations

Name	Description
Errors	Definition of error codes
SymbolType	Definition of a symbol type

Interfaces

Name	Description
AccessControl	Definition of the access right of a control
AngleUnit	Definition of keywords to describe an angle.
Background	Definition of a background
BorderRadius	Definition of the border radius
BorderStyle	Definition of the border style
BorderStyleValue	Definition of keywords to define the style of a border.
BorderWidth	Definition of the border width
BoxShadow	Definition of the control shadow
Comparison	Defines a comparison between a variable and a specified value.
Color	Definition of a color
SolidColor	Definition of a solid color
LinearGradientColor	Definition of a color gradient
Dictionary	An object, whose properties must be of type T and can only be addressed with strings.
DimensionUnit	Dimension unit such as pixel or percent
Endianness	Endianness defines the order in which the bytes that make up a data point are stored
FontStyle	Definition of the font style
Filter	Defines a set of conditions that an object must fulfill.
FontWeight	Definition of a font weight
FourSidedCss	Definition of border width and internal distance
HorizontalAlignment	Definition of keywords to describe a horizontal alignment.
VerticalAlignment	Definition of keywords to describe a vertical alignment.
IResultObject	Generic object for use in callback functions etc.
IErrorDetails	Generic object for describing errors.
IFunction	Definition of a function call for use in TcHmi.Function.
LogicOperator	Defines a logical operation. This is used in filter, for example.
ScaleModeString	Definition of keywords to describe a scaling mode.
SizeMode	Definition of keywords to describe the size mode of a control parameter such as width or height.
SizeModeWithContent	Extended definition of keywords to describe the size mode of a control parameter such as width or height.
StopPoint	Definition of a stop point in a color gradient.
ToggleState	Definition of keywords to describe a toggle state.
Transform	Definition of a transformation
Visibility	Definition of keywords to describe the visibility.
Perpective	Description of the perspective. Used in Transform.
Origin	Description of the reference point. Used in Transform.
Rotate	Description of a rotation. Used in Transform.
Skew	Description of a distortion. Used in Transform.
Scale	Description of a scaling. Used in Transform.
Translate	Description of a movement. Used in Transform.
Context	Context object
EventContext	Event context object
DestroyFunction	Is returned by functions that occupy resources that must be actively released. If the returned function is called, events are canceled, for example.
JsonSchema	JSON schema
IConfig	Represents the contents of the file: tcmiconfig.json.
Version	Describes a version number and provides access to the individual components.
ScaleModeString	Summary of scaling mode values.
baseDependencyFileDescription	Basis of all file dependency definitions.
StyleSheetFileDescription	Extends: baseDependencyFileDescription Describes a CSS (Cascading Style Sheet) file.
JavaScriptFileDescription	Extends: baseDependencyFileDescription Describes a JavaScript file.
ThemedValueFileDescription	Extends: baseDependencyFileDescription Describes a ThemedValues file.
baseThemeDescripiton	Basis of all theme-related file dependency descriptions.
ProjectThemeDescription	Extends: baseThemeDescription Describes files that belong to a theme within a TwinCAT HMI project.
ControlThemeDescription	Extends: baseThemeDescription Describes files of a control that belong to a specific theme.
ISymbolConfig	Defines a list of symbols that are created when the framework is initialized.
InternalSymbolItem	Describes an internal symbol.
Trigger	Defines a trigger that responds to a certain event and executes a list of actions.
IFunction	Defines parameters for calling a TwinCAT HMI function.
IPackageInfo	Describes a TwinCAT HMI NuGet package.
IPartial	Basis of all partial specializations. A partial is a component of an HMI application such as View, Content and UserControl.
IView	Extends IPartial Describes a View file within a TwinCAT HMI project.
IUserControl	Extends IPartial Describes a UserControl file within a TwinCAT HMI project.
IContent	Extends IPartial Describes a content file within a TwinCAT HMI project.
IUserFunction	Describes a TwinCAT HMI function within a TwinCAT HMI project.
TemplateParameter	Describes a parameter that is used in an ActionTemplate.
ActionTemplate	Describes an ActionTemplate within a TwinCAT HMI project.
IProjectKeyboardLayout	Describes a keyboard layout file within a TwinCAT HMI project.
ILanguageFileMap	Describes a key value list of language files.

	Available from 1.8

Further Information