CONTROL
- Introduction to CTRL
- Control Classes
- Types of Control Functions
- 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 - Eigenschaften und Funktionen
  - 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
  - Trend
    - "acceptDrops"
      Specifies whether drop events are enabled for this object.
    - "addCurve"
      The attribute "addCurve" adds a new curve to a trend area.
    - "addTrendArea"
      The attribute "addTrendArea" adds a new trend area to the trend.
    - "areaClosable"
      With the trend attribute "areaClosable" you can close a trend area.
    - "areaFixed"
      With the trend attribute "areaFixed" you can fix a trend area to the current geometry.
    - "areaFreezeTime"
      Returns the point in time when the trend area has been set to frozen.
    - "areaGridMode"
      Defines the mode that is used for the trend area grid.
    - "areaInteractionFlag","areaInteractionFlags","areaPlotInteractionFlags", "areaPlotInteractionFlag"
      Defines the possible interactions with the trend area.
    - "areaLabel"
      The trend attribute "areaLabel" can be used to define a text that is shown above or next to the scale, depending on the orientation of the trend.
    - "areaMargins"
      Defines the margins for an area inside of the trend.
    - "areaMaximumTimeSpan"
      Can be used to set the maximum time span that should be displayed inside of the trend area.
    - "areaMinimumSize"
      The attribute areaMinimumSize can be used to set the minimal size for a trend area.
    - "areaPlotGeometry"
      Returns the geometry of the plot area.
    - "areaPlotOverlayText"
      Defines an overlay text that is displayed over the plot area.
    - "areasClosable"
      With the trend attribute "areasClosable" you can close all trend areas.
    - "areasCollapsible"
      The attribute areasCollapsible can be used to set the size for a trend area to 0 although the minimal size was set.
    - "areaSizes"
      Defines the size relations of the trend areas to each other.
    - "areasMinimumSize"
      The attribute areasMinimumSize can be used to set the minimal size for all trend areas to the same minimal size.
    - "areaStopped"
      Stops the specified area from displaying new values.
    - "areaTouchRulerHideTimeout"
      Defines the time-out for a ruler to be shown inside of the trend area.
    - "areaTouchRulerShowTimeout"
      Defines the time-out for ruler interactions inside of the trend area.
    - "areaViewportPageScrollMode"
      Defines the scroll behavior of the viewport widget.
    - "areaViewportTimeRange"
      Activates a viewport widget which is placed over the plot area.
    - "autoAntiAlias"
      The new trend attribute "autoAntiAlias" can be used to display the trend more accurately.
    - "backgroundImage"
      Sets a background image for a X/Y trend.
    - "connectDirectly"
      Connects a curve and a data point.
    - "connectDirectlyX"
      Connects X values and a data point using the trend type value over value.
    - "controlsAtTop"
      When the attribute "controlsAtTop" have been set to TRUE, the check boxes for the data point curves will be located at the top of the panel.
    - "currentCurve"
      The attribute "currentCurve" returns the part of the trend you right-clicked on.
    - "curveAutoscale"
      Activates or deactivates curve autoscaling.
    - "curveAutoscaleX"
      Activates or deactivates X autoscaling on a curve if the trend type is value over value.
    - "curveColor"
      Sets the color of a curve.
    - "curveDataAt","curveDataAtX"
      Returns the data which is available for a specific curve at a stated point in time.
    - "curveDataAtOffset","curveDataAtOffsetX"
      Returns the data which is available for a specific curve at a stated point in time with an additional offset to the value index.
    - "curveDataAtRuler","curveDataAtRulerX"
      Returns the data which is available for a curve at a specific ruler position.
    - "curveDataSource"
      The attribute "curveDataSource" returns the data point for a specified curve.
    - "curveDelta"
      Defines a delta time, in which the two values of the data points for a curve will be treated as the same. That means that they create a single point. A delta time is meaningful if one of the data points will not begin to send the values at exactly the same time.
    - "curveFillColor"
      With the trend attribute "curveFillColor" you can set the fill color of a trend curve.
    - "curveFilled"
      The attribute "curveFilled" sets the filling of a trend curve.
    - "curveFillType"
      With the trend attribute "curveFillType" you can set the fill type of a trend curve.
    - "curveFormattedValue","curveFormattedValueX"
      Returns the formatted value as displayed inside of the legend.
    - "curveGridAboveCount", "curveGridBelowCount"
      The attribute "curveGridAboveCount" sets the number of grid lines that are shown above the reference value and "curveGridBelowCount" the number of grid lines that are shown below the reference value.
    - "curveGridAboveCountX", "curveGridBelowCountX"
      The attribute "curveGridAboveCountX" sets the number of grid lines that are shown above the reference value for the XY Trend curves of the X part and the "curveGridBelowCountX" the number of grid lines that are shown below the reference value.
    - "curveGridAboveDistance", "curveGridBelowDistance"
      The attribute "curveGridAboveDistance" sets the distance between the grid lines above the reference value and "curveGridBelowDistance" the distance between the grid lines below the reference value.
    - "curveGridAboveDistanceX", "curveGridBelowDistanceX"
      The attribute "curveGridAboveDistanceX" sets the distance between the grid lines above the reference value (for XY trend curves of the X part) and "curveGridBelowDistanceX" the distance between the grid lines below the reference value.
    - "curveGridAuto"
      Turns on/off the automatic grid line positioning for value-over-time trend curves.
    - "curveGridAutoX"
      Turns on/off the automatic grid line positioning for value-over-value trend curves.
    - "curveGridRefVals"
      Allows to define the reference value for the grid lines as well as number of grid lines and the distance between them.
    - "curveGridRefValsX"
      In case of value-over-value trend curves, this attribute allows to define the reference value for the grid lines as well as number of grid lines and the distance between them.
    - "curveGridRefValue"
      The attribute "curveGridRefValue" sets the reference value for the grid line (draws the reference grid line).
    - "curveGridRefValueX"
      The attribute "curveGridRefValueX" sets the reference value (for XY trend curves of the X part) for the grid lines.
    - "curveGridVisible", "curveGridVisibleX"
      The attribute "curveGridVisible" shows or hides the grid lines of a trend curve or an event curve. The attribute "curveGridVisibleX" shows the grid lines for the XY trend curve of the X part.
    - "curveHistory"
      Assigns history Y values from a database to a curve.
    - "curveHistoryX"
      Assigns history X values from a database to a curve.
    - "curveLegendFormat", "curveLegendFormatX"
      Sets the format of a value (of a curve legend). The attribute "curveLegendFormatX" sets the format of a value for an XY trend curve of the X part.
    - "curveLegendName","curveLegendNameX"
      Curve label in curve legend. The attribute "curveLegendNameX" sets the label for XY trend curve of the X part.
    - "curveLegendNamePlotAlignment"
      This attribute defines the position of the name label for an event curve.
    - "curveLegendShowDate", "curveLegendShowDateX"
      The attribute "curveLegendShowDate" shows the date in the legend. The attribute "curveLegendShowDateX" shows the date in the legend for the XY trend curve of the X part.
    - "curveLegendShowMilli", "curveLegendShowMilliX"
      The attribute "curveLegendShowMilli"; shows the milliseconds in the legend. Attribute"curveLegendShowMilliX" shows the milliseconds in the legend for the XY trend curve of the X part.
    - "curveLegendText", "curveLegendTextX"
      Returns the legend text of the stated curve.
    - "curveLegendUnit", "curveLegendUnitX"
      Defines the curve unit in legend. The function "curveLegendUnitX"; sets the unit in the legend for the XY trend curve of the X part.
    - "curveLegendVisibility"
      Shows or hides a curve legend.
    - "curveLineType"
      The attribute "curveLineType" sets the line type of a trend curve.
    - "curveLogScale", "curveLogScaleX"
      CurveLogScale and curveLogScaleX specify per curve whether a curve should be scaled logarithmic.
    - "curveMarking", "curveMarkingX"
      By using the attribute "curveMarking" range of values or a single value can be displayed highlighted. The attribute "curveMarkingX" is used for the XY trend curve of the X part.
    - "curveMax"
      Determines the upper scale limit for a curve.
    - "curveMaxX"
      Determines the highest scale value of X for the curve "Name" for value over value display.
    - "curveMin"
      Determines the lowest scale value for a curve.
    - "curveMinMax"
      Determines the minimum and maximum scale value for a curve.
    - "curveMinX"
      Determines the lowest scale value of X for the curve "Name"; for value over value display.
    - "curveName"
      The attribute "curveName" renames a curve.
    - "curveNames"
      The attribute "curveNames" returns the names of trend curves.
    - "curvePointIcon"
      Defines the icon that should be used for the trend curve points
    - "curveRefCurve"
      The attribute "curveRefCurve" sets the reference curve for filling to another curve.
    - "curveRemoveData"
      Deletes curve data.
    - "curveRemoveInterval"
      Removes the specified interval of a trend curve.
    - "curveResample"
      The attribute "curveResample" enables the curve downsampling.
    - "curveRulerLabelVisibility", "curveRulerLabelVisibilityX"
      With the trend attribute "curveRulerLabelVisibility" or "curveRulerLabelVisibilityX" you can display or hide the accurate value for a horizontal ruler of a trend curve.
    - "curveRulers", "curveRulersX"
      The attribute "curveRulers" or "curveRulersX" shows interactive value based rulers for a trend curve.
    - "curveRulerSnapValue"
      With the trend attribute "curveRulerSnapValue" you can activate the snapping mode (on/off) for the Y-axis for the horizontal ruler while moving it up/down.
    - "curveScaleBackCol"
      Sets the background color for the scale area of a trend.
    - "curveScaleFormat", "curveScaleFormatX"
      Sets the format for the scale range (value range) of a trend curve. The attribute "curveScaleFormatX" sets the format for the XY trend curve of the X part.
    - "curveScaleGeometry","curveScaleGeometryX"
      Returns the geometry of the curve value scale.
    - "curveScalePosition", "curveScalePositionX"
      Sets the scale position of a trend curve.
    - "curveScaleUnitVisibility", "curveScaleUnitVisibilityX"
      This is used to show or hide the unit next to the scale on the y axis.
    - "curveScaleVisibility", "curveScaleVisibilityX"
      This is used to show or hide the scale of the trend during runtime. "curveScaleVisibilityX" is valid for the XY trend curve of the X part.
    - "curveStatic"
      The attribute "curveStatic" creates a static curve in a XY trend.
    - "curveTimeShape", "curveTimeShapeX"
      The attribute "curveTimeShape" specifies what other shapes (primitive text or all other objects that have the property "text") should display the time as it is displayed in the legend. The attribute "curveTimeShapeX" is valid for the XY trend curve of the X part.
    - "curveType"
      The attribute "curveType" sets the type of a trend curve.
    - "curveVal"
      Sets a curve value at a certain time for the trend type value over value.
    - "curveVals"
      Sets curve values at specified times.
    - "curveValue"
      Sets a Y value and status for a curve at a certain time.
    - "curveValueFactor" / "cureveValueFactorX"
    - "curveValues"
      Sets or queries the y values and statuses at certain times.
    - "curveValueShape", "curveValueShapeX"
      The attribute "curveValueShape" specifies what other shapes (primitive text or all other objects that have the property "text") should display the value as it is displayed in the legend. The attribute "curveValueShapeX" is valid for XY trend curve of the X part.
    - "curveValuesProperties"
      The Attribute "curveValuesProperties" allows to set a list of properties for a specific curve value.
    - "curveValuesTexts"
      Maps a text to a certain curve value. Thus, instead the actual value the mapped text is shown in the trend legend and in the window of the ruler value, if the curve takes this value.
    - "curveValuesX"
      Sets or queries the x values and statuses at certain times.
    - "curveValueX"
      Sets an X value and status for a curve at a certain time.
    - "curveValsX"
      Sets several values of a curve at specific times.
    - "curveValX"
      Sets an X value for a curve at a certain time for the trend type value over value.
    - "curveVisible"
      Shows or hides a curve.
    - "curveYoungestPointColor"
      Shows the current/youngest curve value in a value-over-value trend by drawing a point in a specific color.
    - "defaultFont"
      Defines the font which is used for the text of a "event" curve and the Y axis' area label in the trend plot area.
    - "diffRulerTime"
      Returns the point in time for which the differential temporary ruler has been set.
    - "disconnectDirectly"
      Disconnects a curve from a data point.
    - "disconnectDirectlyX"
      Closes the connection between a data point and a curve for value over value display.
    - "disconnectHelpGridDirectly" - obsolete
      Closes the connection between a data point and the drawing grid (obsolete from version 3.5 up).
    - "disconnectRelativeTimeScaleDirectly" - obsolete
      Closes the connection between the time scale and data point variables (obsolete from version 3.5 up).
    - "events" (obsolete)
      Gets all events that are available for a shape. Obsolete, use scriptNames instead.
    - "floatingRulerWindow"
      Sets the positioning behavior of the trend ruler pop-up.
    - "font"
      Sets the font of an object.
    - "freezeOnStop"
      If active (TRUE) the trend starts in "freeze" mode instead of the usual stop mode when a ruler is set.
    - "gotoNow"
      Jumps to the now-time in the trend view.
    - "gotoRuler"
      Jumps to the ruler in the trend view, if activated.
    - "gridColor"
      Sets or gets the grid color of a table or trend grid at runtime.
    - "gridColorX"
      Sets or gets the grid color of the X axis (= vertical grid lines) of a table or trend grid at runtime.
    - "gridLineType"
      Sets or gets the grid line type of a trend grid at runtime.
    - "gridLineTypeX"
      Sets or gets the grid line type of a trend vertical / time grid line at runtime.
    - "imageToClipboard"
    - "imageToFile"
      Saves an image of a graphics object (screenshot).
    - "legendColor"
      Gets or sets the background color of the trend legend.
    - "legendDTV"
      Returns TRUE if the legend shows the Date/Time/Value details or FALSE if the legend shows only the curve description.
    - "legendShowsTimeLabel"
      Shows the date and time in the legend.
    - "legendFont"
      Sets the font for the trend legend.
    - "legendShowsTimeLabel"
      Shows the date and time in the legend.
    - "linkAreas"
      With the trend attribute "linkAreas" you can link two trend areas.
    - "linkCurves"
      Links two curves with each other in order to display the same value range for both curves.
    - "linkedAreas"
      Returns a list of all linked areas.
    - "logarithmicTrend"
      Sets the representation of the trend to logarithmic.
    - "manageCommands"
      Switches the visibility of the scrollbar in the Trend widget on or off.
    - "manageLegend"
      Activates or deactivates the legend in a trend display widget.
    - "maxRulerCount"
      Specifies how many rulers per trend area can be used.
    - "mouseWheelZoomsTime"
      Enables or disables the mouse-wheel zoom for the time scale of the trend.
    - "mouseWheelZoomsValue"
      With the trend attribute "mouseWheelZoomsValue" you can deactivate the zooming with the mouse wheel for the value axis of a trend.
    - "numTrendAreas"
      Defines the number of trend areas for the trend widget.
    - "pointType"
      The attribute "pointType" sets the type of the points for a trend curve.
    - "refValue"
      Reference value from where the area under a curve is colored in.
    - "removeCurve"
      Deletes a trend curve.
    - "removeCurveMarking", "removeCurveMarkingX"
      By using the attribute "curveMarking", a range of values or a single value can be highlighted. The attribute "curveMarkingX" is used for the XY trend curve of the X part. The attribute "removeCurveMarking" deletes this marking.
    - "removeTrendArea"
      Deletes a trend area.
    - "rulerPanel"
      Gets or sets the used ruler panel of the trend widget.
    - "rulerTime"
      Sets/Gets the ruler time of a trend area.
    - "rulerTimes"
      The attribute "rulerTimes" returns or sets the times for a ruler of a trend.
    - "rulerTimeLabelVisibility"
      The attribute "rulerTimeLabelVisibility" shows the time for a curve value of a trend ruler.
    - "rulerValueLabelVisibility"
      The attribute "rulerValueLabelVisibility" shows the curve value for the ruler of a trend curve.
    - "scaleFont"
      Sets the font for the scale of a trend.
    - "scrollPercent"
      When a trend reaches the maximum time, it will be scrolled by the specified amount (%).
    - "showBackgroundGrid"
      This attribute shows the grid lines of a trend in the background or in the foreground.
    - "showGrid"
      This property activates or deactivates the grid of a trend.
    - "timeBegin"
      Start time of the interval displayed in the trend.
    - "timeFormat"
      Changes the format of the time scale.
    - "timeGridInterval"
      Defines whether the grid shall be displayed at the marks of the time axis.
    - "timeInterval"
      Time interval to be displayed in the trend.
    - "timeInUTC"
      Shows all time ranges in the trend in UTC-time (Coordinated Universal Time).
    - "timeOffset"
      Displays an elapsed period in a separate range.
    - "timeScaleVisibility"
      Shows the time scale of a trend at the top, at the bottom or hides it.
    - "timeTrend"
      The attribute "timeTrend" checks whether a trend is a value over time trend.
    - "trendRefresh"
      Redraws the trend widget.
    - "trendRun"
      Runs the trend.
    - "trendStop"
      Stops the trend.
    - "trendStopped"
      Checks if the trend is running.
    - "trendTimeMinus"
      Reduces the resolution of the X-axis.
    - "trendTimePlus"
      Increases the resolution of the X-axis.
    - "trendUnzoom"
      Restores the original resolution of the curves.
    - "trendValueMinus"
      Increases the resolution of the Y-axis.
    - "trendValuePlus"
      Reduces the resolution of the Y-axis.
    - "undoLastZoom"
      Undoes the last zoom in a trend.
    - "unlinkAreas"
      With the trend attribute "unlinkAreas" you can unlink two trend areas.
    - "unlinkCurves"
      Separates linked curves.
    - "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.
    - "vertical"
      The attribute "vertical" sets the trend mode to vertical.
    - "visibleTimeRange"
      Defines the visible start time and end time of the time range in the trend.
  - VideoPlayer.ewo
  - WebView EWO
  - Zoom Navigator
    Functions available for the Zoom Navigator widget.
- CONTROL Functions
- CtrlExtension
- CTRL-Debugger
  Der CTRL-Debugger ermöglicht ein Debuggen der Pogrammiersprache Control. Der Debugger kann über ein eigenes Panel verwendet werden, welches es auch erlaubt die Variablen zu beinflussen, Breakpoints zu setzen, usw.

"areaTouchRulerHideTimeout"

Defines the time-out for a ruler to be shown inside of the trend area.

Synopsis

trendObj.areaTouchRulerHideTimeout(int area, unsigned msec);

getValue(trendObj, "areaTouchRulerHideTimeout", int area, unsigned &msec);

Parameter


Parameter	Description
trendObj	Trend for which the attributed should be get
area	Area ID
msec	Time-out in milliseconds (default 1000)

Description

The function defines the time-out which indicates how long a touch ruler is displayed within the trend area after the touch interaction has been released.

This attribute only works for touch interactions!

Assignment

Trend