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
  - TextEdit
  - Text field
  - Thumb wheel
  - ToggleSwitch EWO
  - Tree widget
    - "acceptDrops"
      Specifies whether drop events are enabled for this object.
    - "addColumn";
      Adds a column to a tree widget.
    - "adjustColumn"
      Adjusts the width of a column so that the widest entry has enough space.
    - "allColumnsShowFocus"
      Shows the focus for all columns of a tree widget.
    - "alternatingRowColors"
      Allows to enable alternating row colors for a selection list / Native_GEDI/DpTreeView.html / Tree Widget.
    - "animated"
      Enables to animate expansion and collapsing of branches.
    - "appendItem", "appendItemNC"
      The attributes "appendItem" and "appendItemNC" both add an item to a tree widget.
    - "appendItems"
      The attributes "appendItems" allows to add new items to a tree widget.
    - "autoCheckParent"
      Sets how a parent node should react if the checked state of his child nodes changes.
    - "autoExpandDelay"
      Sets the delay time before an item in a tree is opened during a drag and drop operation.
    - "autoScroll"
      This attribute can be used to enable autoscrolling in drag move events. The attribute also returns TRUE if autoscrolling in drag move events is enabled; otherwise returns FALSE. (Until Version 3.10 "autoScroll")
    - "autoScrollMargin"
      Sets the size of the area in pixel where auto scrolling is triggered.
    - "changeId"
      Allows to change the ID of an element.
    - "childCount"
      "childCount" returns the number of sub elements.
    - "children"
      The attribute "children" returns the direct sub elements (1. under layer) of a tree widget.
    - "clear"
      Deletes the items of a tree widget.
    - "clearSelection"
      Removes the marking of all items in a graphical object.
    - "collapseAll"
      The function allows to collapse all nodes of a tree.
    - "columns"
      Returns the number of columns.
    - "columnWidthMode";
      Shows which mode is set for a particular column.
    - "contentsX", "contentsY"
      The attributes contentsX and contentsY return the coordinate of an object, for example, of a TextEdit text or of a tree widget. contentsX returns the X coordinate of the contents (text) that are at the left edge of the view. contentsY returns the Y coordinate of the contents (text) that are at the top edge of the view.
    - "contextMenuPolicy"
      Defines how the respective widgets shows the context menu.
    - "currentItem"
      Returns the ID of the element that has the keyboard focus.
    - "defaultRenameAction" - obsolete with version 3.12
      The attribute "defaultRenameAction" specifies what action to perform when the editor loses focus during renaming.
    - "dragEnabled","dropEnabled"
      With the aid of these functions you can query whether the Drag and Drop was enabled for the elements of the tree widget. See also "setDragEnabled", "setDropEnabled".
    - "dropIndicatorPosition"
      This property could be queried in order to find out where the object was dropped. However, it only makes sense if showDropIndicator is set to TRUE.
    - "editTriggers"
      Sets which actions will initiate item editing.
    - "ensureItemVisible"
      The attribute "ensureItemVisible" ensures that an item is visible, scrolling the list view vertically if necessary and opening (expanding) any parent items if this is required to show the item.
    - "expandAll"
      The function allows to expand all nodes of a tree.
    - "expandsOnDoubleClick"
      Sets if the user is able to expand and collapse items by double-clicking.
    - "expandToDepth"
      The function allows to expand all nodes inside of a tree up to a specified depth.
    - "focus"
      The attribute "focus"; returns TRUEif the object has the focus.
    - "focusEnabled"
      Indicates whether the widget accepts keyboard focus.
    - "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).
    - "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).
    - "frameWidth"
      The attribute "frameWidth"; returns the width of a frame (a textEdit, a tree widget, a zoom navigator, LCD number, a thumb wheel etc.)
    - "getAlignment"
      This function returns the alignment set for an item within a column.
    - "getBackColor"
      Gets the background color for an item.
    - "getCellGeometry"
      The read-only property delivers top-left start coordinates as well as width and height of a cell.
    - "getCheckedItems"
      Returns a list of all checked items inside the Tree Widget.
    - "getCheckState"
      Allows to query the checked state of a tree widget item.
    - "getFont"
      Gets the font for an item.
    - "getForeColor"
      Gets the foreground color for an item.
    - "getItemsCheckState"
      Returns a mapping with the element ID as key and the checked state as value.
    - "getText"
      Returns the text of an element.
    - "getToolTip"
      Returns the defined tooltip text of an item in a tree widget.
    - "getUncheckedItems"
      Returns a list of all items which are not checked inside a Tree Widget.
    - "headerHidden"
      Sets whether the header is shown or not.
    - "height"
      The attribute "height" returns the height of an object (textEdit, progress bar, tree widget, zoom navigator, LCD number or a thumb wheel.)
    - "hideColumn"
      Hides a column of a tree widget.
    - "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")
    - horizontalScrollMode
      Defines the scroll mode in horizontal direction.
    - "insertItem", "insertItemNC"
      The attributes "insertItem"; and "insertItemNC"; both add an item to a tree widget.
    - "isActiveWindow"
      The attribute "isActiveWindow"; returns TRUE if this widget is the active window, otherwise FALSE.
    - "isCheckable"
      Allows to query whether a item of a Tree Widget is checkable or not.
    - "isChecked"
      Allows to query whether a item is checked or not.
    - "isColumnHidden";
      Shows whether a column is hidden or not.
    - "isEnabled";
      Shows whether an element has been enabled (see "setEnabled").
    - "isExpandable"
      Returns TRUE if an element is expandable even when it has no children; otherwise returns FALSE.
    - "isOpen"
      Returns TRUE if a tree widget element has children and they are not explicitly hidden; otherwise returns FALSE.
    - "isVisible"
      Returns TRUE if an item is visible.
    - "itemAbove", itemBelow"
      "itemAbove"; returns the item above this specified item and "itemBelow"; the item below this specified item of the same level (or parent).
    - "itemExists"
      The attribute "itemExists"; is used to check whether the specified item exists in a tree widget or not.
    - "itemMargin" - obsolete with version 3.12
      "itemMargin"; sets the item margin for tree widget items.
    - "itemsExpandable"
      Sets if the user is able to expand and collapse items interactively.
    - "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.
    - "maximumHeight, maximumWidth"
      The attribute "maximumHeight"; returns the maximum height of a textEdit (excluding any window frame), a tree widget or a slider and the attribute "maximumWidth"; the maximum width of a textEdit, a tree widget or a slider.
    - "minimumHeight, minimumWidth"
      The attribute "minimumHeight"; returns the minimum height of a textEdit (excluding any window frame), a tree widget or of a slider and the attribute "minimumWidth"; the minimum width of a textEdit, tree widget or a slider.
    - "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).
    - "moveItemId";
      The function "moveItemId"; changes the place of an item in the cascade.
    - "multiSelection" (replaced by "selectionMode" since version 3.11)
      Allows to select several items of a tree widget at the same time.
    - "ownCursor";
      The attribute "ownCursor" returns TRUE if an object (for example a textEdit, a tree widget, a slider, a zoom navigator or a thumb wheel) uses its own cursor. If the value is FALSE, the object uses its parent widget`s cursor.
    - "ownFont";
      The attribute "ownFont"; returns TRUE if an object (for example, a textEdit, a slider, a zoom navigator or a tree widget) uses its own font. If the value is FALSE, the object uses its parent widget`s font.
    - "parent";
      Returns the parent of an item or an empty string if the item has no parent.
    - "removeColumn"
      Removes a column of a tree widget.
    - "removeItem"
      Deletes the specified entry.
    - "removeItems"
      Deletes the specified items.
    - "resizeMode" - obsolete with version 3.12
      This attribute specifies whether all, none or the only the last column should be resized.
    - "rootIsDecorated"
      The attribute "rootIsDecorated" specifies whether the tree view shows open/close signs on root items.
    - "selectedItem"
      The attribute "selectedItem" returns the selected item if a tree widget is in single selection mode and an item has been selected.
    - "selectedItems"
      The attribute returns the IDs of the selected items.
    - "selectionBehavior"
      Sets whether selections are done in terms of single items, rows or columns.
    - "selectionMode"
      The attribute "selectionMode" defines how an object, for example, a tree view reacts to selection by a user.
    - "setAlignment"
      This function allows you to define an alignment for an item in a column within the tree widget.
    - "setAllChecked"
      Sets all items of a tree widget to the state checked.
    - "setBackColor"
      Sets the background color for an item.
    - "setCheckable"
      Sets if a node is checkable inside a tree widget.
    - "setChecked"
      Sets the checked state of one or more tree widget items.
    - "setColumnWidth"
      Sets the column width (column of a tree widget).
    - "setColumnWidthMode"
      This function allows to change the width mode of a column.
    - "setDragEnabled", "setDropEnabled"
      The functions enable the drag and drop at runtime for the tree widget.
    - "setEnabled"
      Enables or disables an item.
    - "setExpandable"
      Allows to set one or more items to be expandable (even if it has no children) if enable is TRUE and if enable is FALSE, to be expandable but only if it has children.
    - "setFont"
      Sets the font for an item.
    - "setForeColor"
      Sets the foreground color for an item.
    - "setIcon"
      Sets an icon for a line in the tree widget.
    - "setIconAdjusted"
      Sets an icon for a line in the tree widget. Identical to the property "setIcon" but this function adjusts the size of the image to the available space.
    - "setOpen"
      Sets an item to open if open is TRUE and the item is expandable or to close if open is FALSE.
    - "setRenameEnabled"
      The attribute "setRenameEnabled" specifies if an item can be in-place renamed in the column.
    - "setResizeEnabled"
      Prevents columns to be resized or allows changing the size of all columns.
    - "setSelectedItem"
      Selects the specified item.
    - "setSelectedItems"
      Selects a specified items.
    - "setSorting"
      Arranges the items of a column alphabetically in ascending or descending order.
    - "setText"
      Sets the text for an item.
    - "setToolTip"
      Specifies the tooltip text for the selective item in a column of a tree widget.
    - "setVisible"
      Sets an item visible.
    - "showDropIndicator"
      Sets if the drop indicator is shown while dragging or dropping items.
    - "showHeader"
      Shows the header of a tree widget or hides it.
    - "showSortIndicator"
      Defines whether an arrow is shown next to the column header, which indicates whether the items are sorted in ascending or descending order.
    - "showToolTips" - obsolete with version 3.12
      Specifies whether the tree view shows tool tips for truncated column texts.
    - "sortingEnabled"
      Sets whether sorting is enabled
    - "startRename"
      If in-place renaming of the specified item is enabled (see "setRenameEnabled"), this function starts renaming the item in the specified column, by creating and initializing an edit box.
    - "tabKeyNavigation"
    - TextEdit
    - "tooltipDuration"
      Specifies how long a tooltip is shown.
    - "treeStepSize"
      Specifies the number of pixels a child is offset from its parent.
    - "underMouse"
      Returns TRUE if a widget (textEdit, slider, thumb wheel, tree widget, zoom navigator, LCD number or progress bar) is beneath the cursor.
    - "uniformRowHeights"
      Defines if all items in the widget have the same height.
    - "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.
    - "visibleHeight"
      This property holds the vertical amount of the content that is visible.
    - "visibleWidth"
      This property holds the horizontal amount of the content that is visible.
    - "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")
    - "wordWrap"
      The attribute "wordWrap" specifies the different word wrap modes.
    - "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.
  - 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.

"collapseAll"

The function allows to collapse all nodes of a tree.

Synopsis

shape.collapseAll();

Parameter


Parameter	Description
shape	Name of the object

Description

The function allows to collapse all nodes of a tree.

Assignment

Tree Widget