CONTROL
- Introduction to CTRL
  An introduction to the product's own programming language Control(CTRL).
- CONTROL Classes
- Types of Control Functions
  An overview of the types of functions distinguished within Control.
- Control graphics
  - Graphics objects
  - Attributes of graphics objects
  - Arc
  - AttentionEffect EWO functions
  - Bar trend
  - BarChart3D EWO
  - Button
  - Calendar
  - Cascade
  - Chart.ewo
  - Checkbox
  - Clock
  - Combobox
  - DateTimeEdit EWO functions
  - DialGauge EWO
  - DoubleSpinbox EWO
  - DpTreeView
    - "acceptDrops"
      Specifies whether drop events are enabled for this object.
    - "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.
    - "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.
    - "columnCount"
      This property holds the number of columns displayed in the widget.
    - "contextMenuPolicy"
      Defines how the respective widgets shows the context menu.
    - "dpElementTypeFilter"
      Filters the view in the datapoint tree for specific datapoint element types.
    - "dpFilter"
      Filters the view in the datapoint tree for specific datapoints.
    - "dpFilterIgnoresCase"
      Case sensitivity is ignored when a datapoint filter is set for the DpTreeView.
    - "dpTypeFilter"
      Filters the view in the datapoint tree for specific datapoint types.
    - "editTriggers"
      Sets which actions will initiate item editing.
    - "ExpandElements"
      This attribute expands all nodes that contain the given datapoint.
    - "expandsOnDoubleClick"
      Sets if the user is able to expand and collapse items by double-clicking.
    - "expandedStateName"
      Saves/Returns the string name to which the last expanded view in the DP tree is saved.
    - "focus"
      The attribute "focus"; returns TRUEif the object has the 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.)
    - "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.)
    - "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.
    - "imageToClipboard"
    - "imageToFile"
      Saves an image of a graphics object (screenshot).
    - "indentation"
      Defines the indentation in pixels of items for each tree level.
    - "isActiveWindow"
      The attribute "isActiveWindow"; returns TRUE if this widget is the active window, otherwise FALSE.
    - "itemsExpandable"
      Sets if the user is able to expand and collapse items interactively.
    - "itemMargin" - obsolete with version 3.12
      "itemMargin"; sets the item margin for tree widget items.
    - "lastNode"
      Defines the last node type (DPT, DP, DPE, ...) which should be shown in the data point tree view.
    - "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.
    - "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).
    - "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" of the DPTreeView returns the datapoint identifier of the selected Element as string.
    - "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.
    - "SetDpFilter"
      Sets a datapoint filter for the DpTreeView.
    - "showDropIndicator"
      Sets if the drop indicator is shown while dragging or dropping items.
    - "showInternalDpTypes"
      Defines whether internal datapoints should also be shown in the view of the data point tree.
    - "showMasterDps"
      Allows to define whether Master DPs are displayed inside the DPTreeView or stay hidden.
    - "sortingEnabled"
      Sets whether sorting is enabled
    - "tabKeyNavigation"
    - "textElideMode"
      Defines the elide mode, i.e. how the text is shown if there is not enough space for the entire text.
    - "tooltipDuration"
      Specifies how long a tooltip is shown.
    - "topLevelItemCount"
      Defines the number of top level items.
    - "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.
    - "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")
    - "verticalScrollMode"
      Defines the scroll mode in vertical direction.
    - "width"
      The attribute "width" returns the width of an object (e.g. a textEdit, a zoom navigator or a slider).
    - "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.
  - 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
  - WebView EWO
    All events and functions, specifically available for the WebView EWO.
  - Zoom Navigator
    Functions available for the Zoom Navigator widget.
- CONTROL Functions
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRLPPCheck
  Save time and money with increased code quality in your projects

"SetDpFilter"

Sets a datapoint filter for the DpTreeView.

Synopsis

setValue(string shape, "SetDpFilter", string filter);

getValue(string shape, "SetDpFilter", string &filter);

shape.SetDpFilter(string filter);

Parameter


Parameter	Description
shape	Name of the object
filter	Datapoint name or datapoint pattern

Description

Sets a datapoint filter for the DpTreeView. Use the wildcard "*" to generalize the filter.

Example

In the following example only datapoints whose names contain "*ample*" are displayed.

main()
{
  DP_TREE1.SetDpFilter("*ample*");
}

Assignment

DpTreeView