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
  - Radio box
  - Rectangle
  - Reference Functions
  - Scheduler.ewo
  - Selection list
  - Slider
  - Spin button
  - Splitter
  - Tab
  - Table
    - "acceptDrops"
      Specifies whether drop events are enabled for this object.
    - "addSelectColumns"
      Adds columns to a table selection.
    - "addSelectLines"
      Adds lines to a table selection.
    - "adjustColumn"
      Adjusts the width of a column so that the widest entry has enough space.
    - "alternatingRowColors"
      Allows to set alternating background colors for the rows of a table.
    - "appendLine"
      Appends either a row containing values or an empty row. to the table
    - "appendLines"
      Appends several rows to a table.
    - "blankNonExistingRows"
      Allows to define whether empty rows are visible or not.
    - "cellBackCol"
      Defines the background color of an active cell.
    - "cellBackColRC"
      Defines the background color of a cell at a specific position.
    - "cellEditableRC"
      Gets / sets if a specific cell inside of the table can be edited.
    - "cellFillRC"
      Specifies the fill pattern for a table cell.
    - "cellFontRC"
      Sets the font for a table cell.
    - "cellForeCol"
      Defines the text color for the active cell.
    - "cellForeColRC"
      Defines the text color of a cell at a specific position.
    - "cellFormatRC"
      Defines the text format of a specific row and column in a table.
    - "cellGeometry"
      The read-only property delivers top-left start coordinates as well as width and height of a cell.
    - "cellToolTipRC"
      Defines the tool tip text for a specific cell in a table.
    - "cellValue"
      Defines the contents of the active cell.
    - "cellValueRC"
      Defines the contents of a cell in a particular row and column.
    - "cellWidgetRC"
      Adds a widget (a push button or a combo box) to a table.
    - "columnCount"
      Defines the number of columns.
    - "columnEditable"
      Defines the editing mode for a column.
    - "columnFormat"
      Defines the text format of a specific table column.
    - "columnHeader"
      Changes specific column labels in the table header.
    - "columnHeaderAlignment "
      The alignment of the table header.
    - "columnHeaderIcon"
      Defines an icon for the table header of a column.
    - "columnHeaderToolTip"
      The tool tip shown for the column header.
    - "columnHeaderVisibility"
      The table header is shown or hidden.
    - "columnMovingEnabled"
      Single columns of a table can be dragged by means of the mouse.
    - "columnName"
      Sets the name for a table column at runtime. Note that not the title but the name of the column will be set. The same attribute also returns the column name of the defined column index at runtime.
    - "columnPlaceholderText"
      This text is displayed grayed out until the user writes something in the input area of the column.
    - "columnStretchable"
      This attribute allows the width of a table column to be adjusted if the table's width decreases or increases.
    - "columnToName"
      Reads column names.
    - "columnToolTipText"
      This attribute defines a text that will be displayed when the cursor points at the column of a table.
    - "columnVisibility"
      Shows or hides a column.
    - "columnWidth"
      Gets or sets the width of a table column in pixels.
    - "currentCell"
      Sets or reads the column number and row number of an active cell. The property also returns the column and row indexes of a table when programmed as RightMousePressed event.
    - "currentColumn"
      Returns the name of an active column.
    - "deleteAllLines"
      Deletes all the rows in a table.
    - "deleteColumn"
      Deletes a table column.
    - "deleteLine"
      Deletes a row if certain conditions are met.
    - "deleteLineN";
      Deletes a specific row.
    - "deleteLines"
      Searches columns with key values and deletes all lines in which these values exist.
    - "deleteLinesN"
      A specific number of rows are deleted, starting from an indexed row.
    - "deleteSelection"
      Clears the selection made in a table.
    - "enableColumnResize"
      This function allows resizing of table column widths with the mouse.
    - "enableRowResize"
      This function allows resizing of table row heights with the mouse.
    - "events" (obsolete)
      Gets all events that are available for a shape. Obsolete, use scriptNames instead.
    - "exchangeColumnName"
      Changes a column name at runtime.
    - "exchangeColumns"
      Swaps over two columns in a table.
    - "filterRows";
      The attribute "filterRows" shows or hides rows according to the "show"; argument if a pattern match in a column is found (see description further on).
    - "filterRowsIgnoreCase";
      The attribute "filterRowsIgnoreCase" shows or hides rows, just as "filterRows" does. However, this function ignores the case when trying to find a pattern match.
    - "font"
      Sets the font of an object.
    - "getColumnN"
      Returns the content of a column.
    - "getColumnWidth"
      Returns the width of the column.
    - "getLineN"
      Returns the elements of row "n" in a dyn_var.
    - "getSelectedCells"
      The dyn_dyn_int contains (row, column) items for each selected cell.
    - "getSelectedColumns"
      Returns the indices of the selected columns.
    - "getSelectedLines"
      Returns the indices of the selected rows.
    - "gridColor"
      Sets or gets the grid color of a table or trend grid at runtime.
    - "gridType"
      "gridType" specifies whether the column and row grid lines or both of a table will be shown or not.
    - "horizontalScrollBarPolicy" / "hScrollBarMode"
      The attribute "horizontalScrollBarPolicy"; sets the horizontal scroll bar mode of an object, for example, textEdit, tree widget or a table. (Until Version 3.10 "hScrollBarMode")
    - "insertColumn"
      Adds a column to a table.
    - "insertLineN"
      Inserts an empty row after a specified row.
    - "isColumnVisible";
      This function checks whether the active column is visible.
    - "isHorizontalSliderPressed"
      Defines whether the horizontal slider is pressed.
    - "isRowHidden";
      The attribute "isRowHidden" returns TRUE if the specified row is hidden.
    - "isVerticalSliderPressed"
      Returns if the vertical slider is pressed.
    - "lineCount";
      Returns the number of rows in a table.
    - "lineHeight"
      Gets or sets the height of a specific line inside of the table widget.
    - "lineNumbers"
      Returns the line number of the rows that are stated inside the mapping keys.
    - "lineParam";
      Changes the cell attributes in certain rows depending on their contents.
    - "lineRangeVisible"
      Returns the upper and lower limits of the rows currently visible.
    - "lineVisible"
      Forces that a specific line of the table remains in the visible table area.
    - "namedColumnEditable"
      Sets the edit mode for a specific column.
    - "namedColumnHeader"
      Changes the title of a specific column.
    - "namedColumnToolTipText"
      This attributes defines a text that is displayed when the cursor points to a table column.
    - "namedColumnVisibility";
      Shows or hides a specific column.
    - "namedColumnWidth"
      Changes the width of a named column. The width of the column is defined in pixels.
    - "nameToColumn"
      Returns the column index.
    - "removeSelectColumns"
      Removes columns from a table selection.
    - "removeSelectLines"
      Removes lines from a table selection.
    - "rowFontType"
      Sets font types per line in a table at runtime. The attribute rowFontType is used in connection with appendLine, appendLines, updateLine, updateLines and insertLineN.
    - "rowHeader"
      Adds a header to a table row.
    - "rowHeaders"
      Adds several row headers to a table.
    - "rowHeaderToolTip"
      Adds a tooltip to a header of a table row.
    - "rowHeaderVisibility"
      Shows or hides the row headers.
    - "rowHeaderWidth"
      Sets the width of row headers.
    - "rowHeight"
      Sets the height for a table row.
    - "selectByClick"
      Specifies the selection mode when you click into the table.
    - "selectColors"
      Defines the color for the selected cells.
    - "selectColumnN"
      Selects a specific column in a table.
    - "selectLineN"
      Selects a specific line in a table.
    - "setCurrentLine"
      Sets the current line.
    - "showRow", "hideRow"
      The attribute "showRow" shows a row of a table. The attribute "hideRow" hides a row.
    - "sort"
      Sorts the table by columns.
    - "sortDyn"
      Sorts the table by columns passed in an array.
    - "sortOnClick"
      Controls table sorting when a table header is clicked on.
    - "sortOrig"
      Returns to a particular table sort order.
    - "sortPart"
      Sorts a section in the table.
    - "sortUndo"
      Discards the last sort.
    - "stop"
      Defines if the table should scroll if new entries are added.
    - "tableMode"
      Sets the table mode.
    - "updateLine"
    - "updateLines"
      Finds columns using key values and replaces certain values in multiple lines.
    - "updateLinesThreshold"
      Defines how many lines minimum there have to be in order to use the new algorithm for the Control_Grafik/updateLines.html function.
    - "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.
    - "verticalScrollBarPolicy" / "vScrollBarMode"
      The attribute "verticalScrollBarPolicy" sets the vertical scroll bar mode of an object e.g. of a textEdit, a tree widget or a table. (Until Version 3.10 "vScrollBarMode")
    - "writeToFile"
      Writes the content of a table to a file. This function can also be used to export an ODS file.
  - TextEdit
  - Text field
  - Thumb wheel
  - ToggleSwitch EWO
  - Tree widget
  - Trend
  - VideoPlayer.ewo
  - WebView EWO
    All 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.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
- NextGen Archiver Backend-API
  This chapter describes the NextGen Archiver Backend API
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.

"isVerticalSliderPressed"

Returns if the vertical slider is pressed.

Synopsis

getValue (string shape, "isVerticalSliderPressed", bool &pressed);

shape.isVerticalSliderPressed(bool &pressed);

Parameters


Parameter	Description
pressed	TRUE: vertical Slider pressed FALSE: vertical Slider not pressed

Description

Returns the "Pressed" state of the vertical slider of the shape.

"isVerticalSliderPressed"

Synopsis

Description

Assignment