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
  - Panel functions
  - Reference Functions
  - Arc
  - AttentionEffect EWO functions
  - Bar trend
  - BarChart3D EWO
  - Button
  - Chart.ewo
  - Calendar
  - Cascade
  - 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
  - PDF Viewer EWO
  - PictureFlow EWO functions
  - Pipe
  - Polyline
  - Primitive text
  - Progress bar
    - "acceptDrops"
      Specifies whether drop events are enabled for this object.
    - "alignment"
      Changes the alignment at the cursor position or the alignment of the selected text.
    - "centerIndicator"
      The attribute "centerIndicator" specifies whether the indicator string should be centered or not.
    - "focus"
      The attribute "focus"; returns TRUEif the object has the focus.
    - "format"
      Defines the format in which the text of the progress bar is shown.
    - "frameShape"
      The attribute "frameShape" sets the style of an object frame (textEdit frame, a thumb wheel, a tree widget, a zoom navigator , an LCD number or a progress bar).
    - "frameShadow"
      The attribute "frameShadow" specifies the frame effect (3D effect) of an object (textEdit, progress bar, tree widget, thumb wheel, LCD number, DpTreeView or zoom navigator).
    - "height"
      The attribute "height" returns the height of an object (textEdit, progress bar, tree widget, zoom navigator, LCD number or a thumb wheel.)
    - "indicatorFollowsStyle"
      The attribute "indicatorFollowsStyle" specifies whether the display of the indicator string should follow the GUI style.
    - "invertedAppearance"
      Changes the direction of the slider into top = minimum value and bottom = maximum value.
    - "isActiveWindow"
      The attribute "isActiveWindow"; returns TRUE if this widget is the active window, otherwise FALSE.
    - "layoutDirection"
      Defines the widget's layout direction.
    - "lineWidth"
      The attribute "lineWidth"; sets the width of an object (a textEdit, progress bar, tree widget, zoom navigator, LCD number or a thumb wheel (frame) ) line.
    - "margin" - obsolete with version 3.12
      The attribute "margin" specifies the distance between the innermost pixel of the frame and the outermost pixel of the rectangle inside the frame.
    - "maximum"
      Defines the upper limit of the value range.
    - "midLineWidth"
      The attribute "midLineWidth" sets the width of the mid line (content) of an object (for example, a thumb wheel, tree widget, zoom navigator, LCD number or a progress bar).
    - "minimum"
      Defines the lower limit of the value range.
    - "orientation";
      Sets the orientation of a slider, a thumb wheel, a progress bar or a spacer.
    - "percentageVisible"
      Defines whether the current progress is displayed.
    - "progess";
      The attribute "progress"; sets the progress bar.
    - "progressString";
      Returns the degree of progress as a string.
    - "reset"
      Resets the progress bar.
    - "textDirection"
      Defines the text direction in a vertical progress bar.
    - "textVisible"
    - "tooltipDuration"
      Specifies how long a tooltip is shown.
    - "totalSteps"
      This attribute specifies the total number of steps.
    - "underMouse"
      Returns TRUE if a widget (textEdit, slider, thumb wheel, tree widget, zoom navigator, LCD number or progress bar) is beneath the cursor.
    - "updatesEnabled"
      This attribute specifies whether updates of a widget (for example, a textEdit, slider, progress bar, zoom navigator, LCD number or thumb wheel) have been enabled.
    - "value"
      Sets the current value of a slider.
    - "x", "y"
      The attributes x and y return the coordinate of an object (e.g. a textEdit, a progress bar, a slider, a zoom navigator, an LCD number or a thumb wheel). x returns the X coordinate of an object. y returns the Y coordinate of an object.
  - Radio box
  - Rectangle
  - Reference Functions
  - Scheduler.ewo
  - Selection list
  - Slider
  - Spin button
  - Splitter
  - Tab
  - Table
  - TextEdit
  - Text field
  - Thumb wheel
  - ToggleSwitch EWO
  - Tree widget
  - Trend
  - VideoPlayer.ewo
  - 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.
- 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.
WinCC OA Documentation
Basic information about terms and functions within the documentation.
Disclaimer
A brief clarification of liability exclusions or legal notices.

"format"

Defines the format in which the text of the progress bar is shown.

Synopsis

setValue (string shape, "format", string textFormat);

getValue (string shape, "format", string &textFormat);

shape.format(string textFormat);

shape.format(string textFormat);

Parameters


Parameter	Description
shape	Name of the object
textFormat	%m - text shows the number of steps %p - text shows the percentage %v - text shows the current value

Description

Defines the format in which the text of the progress bar is shown.

Assignment

Progress bar