Version Information
Release Notes, Update information, Certifications and Frequently Asked Questions.
Concepts
Your first step into modern and powerful process visualization.
Deployment
Topics you need to know before using WinCC OA.
Security
Go beyond the norm in cybersecurity.
Engineering
Powerful tools for easy or complex engineering tasks.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
- Introduction to CTRL
  An introduction to the product's own programming language Control(CTRL).
- Control Classes
  The overview of classes available in Control.
- Types of Control Functions
  An overview of the types of functions distinguished within Control.
- Control graphics
  - Graphics objects
  - Attributes of graphics objects
    - Color string
      Differentiates between static and dynamic colors. Static colors do not change the color, whereas dynamic colors constitute a flashing pattern. Of course static colors can still be changed. Rapid periodic color changes are best realized with dynamic colors, however, which do not require any object Redraw.
    - Line-type string
      The line type defines how lines and curves are implemented, such as the borders for rectangles, circles, ellipses, polygons and plain texts. A line-type definition has five different parameters in WinCC OA, which must all be passed in a line-type string.
    - Fill-pattern string
    - Font string
      The font defines how individual characters in e.g. text fields, trend widgets, tables, selection lists, spin buttons, combo boxes, etc. will be implemented. Font strings are specified in a QT internal format, which are dealt with in the relevant manuals. This subject will not be dealt with here. For programming Control scripts, a dialog box can be opened from the script editor, which can be used to automatically insert the string with the required font into the script (see also chapter Font).
    - Format string
      Format strings specify the formatting of text fields and those plain texts used as output fields. Format strings consist of five arguments, although not all of these need to be specified. The position of the arguments in the string must be defined, however. For instance, if only the third parameter is to be set, the string must contain at least two commas, followed by the third parameter.
    - "antiAliased"
      The attribute defines if anti aliasing is used for the object.
    - "backCol"
      The attribute can be used to set the background color of a shape.
    - "cursor"
      The attribute "cursor" specifies the cursor type.
    - "effectiveFont"
      The read-only property returns the current font of the widget.
    - "focusPolicy"
      Gets or sets the focus policy.
    - "horizontalSizePolicy", "verticalSizePolicy"
      Allows to read/write the size policy of ashape, panel, shape group or panel reference..
    - "hotKey"
      This attribute returns the hot key for a shape.
    - "imageToClipboard"
    - "imageToFile"
      Saves an image of a graphics object (screenshot).
    - "layer"
      Defines the layer of a shape.
    - "layoutDirection"
      Defines the widget's layout direction.
    - "mapFromGlobal"
      The property allows to convert the global coordinates into panel relative coordinates.
    - "mapToGlobal"
      The property allows to convert the panel relative coordinates into global coordinates.
    - "minimumSize","maximumSize"
      Allows to define the minimum / maximum size of a shape
    - "namePath"
      This function returns the name path to the shape in the notation "Ref1.SubRef2.ShapeName3" for shapes within panel references.
    - "ownerRef"
      This read-only attribute returns a pointer to the panel reference the shape belongs to.
    - "panel"
      Returns the panel on which the graphics object is placed.
    - "panelFileName"
      Returns or writes the panel name of a reference in a panel.
    - "points"
      Sets or gets the geometrical representation of the object.
    - "refName";
      Returns the reference information for a shape meaning to what reference a shape belongs to.
    - "refPoint"
      Allows to read/write the reference point coordinates.
    - "script"
      Gets or sets the event script of a shape.
    - "scriptables"
      Gets all properties that are available for a shape.
    - "scriptNames"
      Gets all events that are available for a shape.
    - "shadowColor"
      This function sets the color for a shadow of a shape.
    - "shadowEnabled"
      This function enables or disables the shadow of an object.
    - "shadowOffset"
      This function specifies the number of pixels that the shadow is offset on the x- and y-axis.
    - "shadowRadius"
      This function sets the radius of an object's shadow.
    - "shapeType"
      Returns a string specific to the type of shape.
    - "showFocus"
      Defines if an object displays the focus state.
    - "styleSheet"
      Allows to define a custom style for separate widgets or panels to individually adapt them. These styles override the general stylesheet settings.
    - "toolTipText"
      This function sets a tool tip (for a corresponding graphics object. The text is displayed when the cursor points at the graphics object.
    - "transparentForMouse"
      The attribute "transparentForMouse" allows to prevent objects from using mouse events while objects in the background can be used with the mouse.
    - "transparentForMouseInGedi"
      The attribute "transparentForMouseInGedi" allows to prevent objects from using mouse events while objects in the background can be used with the mouse.
    - "zOrderAfter()"
      Moves a shape to be drawn after another shape.
    - "zOrderToBottom()"
      Moves a shape to be at the bottom.
    - "zOrderToBottom()"
      Moves a shape to be the top-most.
  - Arc
  - AttentionEffect EWO functions
  - Bar trend
  - BarChart3D EWO
  - Button
  - Calendar
  - Cascade
  - Chart.ewo
  - Checkbox
  - Clock
  - Combobox
  - DateTimeEdit EWO functions
  - DialGauge EWO
  - DoubleSpinbox EWO
  - DpTreeView
  - DpTypeView
  - Embedded module
  - Frame
  - GIS Viewer EWO
    WinCC OA GIS Viewer provides the cartographic representation of objects in WinCC OA. This new feature provides numerous advantages, particularly in geographical distributed systems, like in Water, Traffic, Oil & Gas or Energy.
  - Label Functions
  - Layoutgroup functions
  - LCD number
  - Maps Widget - Properties and Functions
  - Panel functions
  - PDF Viewer EWO
  - PictureFlow EWO functions
  - Pipe
  - Polyline
  - Primitive text
  - Progress bar
  - Radio box
  - Rectangle
  - Reference Functions
  - Scheduler.ewo
  - Selection list
  - Slider
  - Spin button
  - Splitter
  - Tab
  - Table
    The available functions of the Table object.
  - TextEdit
  - Text field
  - Thumb wheel
  - ToggleSwitch EWO
  - Tree widget
  - Trend Functions
  - VideoPlayer.ewo
  - WebView EWO
    All events and functions, specifically available for the WebView EWO.
  - Zoom Navigator
    Functions available for the Zoom Navigator widget.
- CONTROL Functions
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.
- SQL in CONTROL
  The database functions enable you to quickly carry out value queries on data points and elements.
- WinCC OA JavaScript Manager for Node.js
  The WinCC OA JavaScript Manager for Node.js is a manager that allows for the integration of the TypeScript/JavaScript runtime environment Node.js® into WinCC OA.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
Data Visualization
User interfaces, Trends and Reports for every purpose and device.
Southbound Interfaces
The process connection to the actual machines/sensors.
Northbound Interfaces
Your portal to the cloud or supervising systems.
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
User Management
All about authorization, authentication and login-customization.
Availability
How to get your system uptime to the maximum.
Reporting
Create state of the art project reports without limits.
Addons
Useful tools and enhancements for special demands.
Reference Tables
Detailed and extensive content for special project adaptation.
Videos & Tutorials
Explore the capabilities of WinCC OA with our carefully selected collection of video tutorials and guides.
Documentation
Basic information about terms and functions within the documentation.
Support & Services
An experienced team of support agents, consultants and trainers are ready to facilitate active partnerships with our customers, so they can profit from our comprehensive service.
Disclaimer
A brief clarification of liability exclusions or legal notices.

"hotKey"

This attribute returns the hot key for a shape.

Synopsis

void shape.hotKey(string);

Parameters


Parameter	Description
string	The hot key as a string.

Description

The read-only attribute hotKey returns the hot key that was assigned to a shape.

The example shows the hot key for a shape in the tooltip.

main()
{
  this.toolTipText("hotkey: "+this.hotKey());
}

Assignment

CTRL