Startseite
CONTROL
Control graphics
DpTypeView
"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).

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
    - "acceptDrops"
      Specifies whether drop events are enabled for this object.
    - "allColumnsShowFocus"
      Shows the focus for all columns of a tree widget.
    - "alternatingRowColors"
      Allows to set alternating background colors for the rows of a table.
    - "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.
    - "childCount"
      "childCount" returns the number of sub elements.
    - "columnCount"
      This property holds the number of columns displayed in the widget.
    - "columns"
      Returns the number of columns.
    - "contentsHeight, contentsWidth"
      The attribute "contentsHeight" returns the height of an object, for example, the height of a TextEdit text area. The attribute "contentsWidth" again returns the width of a TextEdit text area.
    - "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.
    - "defaultRenameAction" - obsolete with version 3.12
      The attribute "defaultRenameAction" specifies what action to perform when the editor loses focus during renaming.
    - "dpTypeName"
      Specifies which data point type should be shown in a DPTypeView.
    - "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")
    - "dragDropMode"
      Defines the drag / drop mode for the widget.
    - "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".
    - "editTriggers"
      Sets which actions will initiate item editing.
    - "expandedStateName"
      Saves/Returns the string name to which the last expanded view in the DP tree is saved.
    - "expandsOnDoubleClick"
      Sets if the user is able to expand and collapse items by double-clicking.
    - "focus"
      The attribute "focus"; returns TRUEif the object has the focus.
    - "focusEnabled"
      Indicates whether the widget accepts keyboard focus.
    - "font"
      Sets the font of an object.
    - "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.)
    - horizontalScrollMode
      Defines the scroll mode in horizontal direction.
    - "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")
    - "imageToClipboard"
    - "imageToFile"
      Saves an image of a graphics object (screenshot).
    - "dateFont"
      Sets the font for a date.
    - "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.
    - "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.
    - "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).
    - "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.
    - "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.
    - "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.
    - "showDatatypes"
      Specifies whether the datatypes (of the elements) of a data point type are shown in a DPTypeView.
    - "showDropIndicator"
      Sets if the drop indicator is shown while dragging or dropping items.
    - "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
    - "systemName"
      Specifies from which system a data point should be shown using "dpTypeName".
    - "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.
    - "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.
    - "verticalScrollMode"
      Defines the scroll mode in vertical direction.
    - "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.
  - 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
  - WebView EWO
  - Zoom Navigator
    Functions available for the Zoom Navigator widget.
- CONTROL Functions
- CTRL-Debugger
  Der CTRL-Debugger ermöglicht ein Debuggen der Pogrammiersprache Control.
- CtrlExtension

"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).

Synopsis

setValue(string shape, "frameShape", string frame);

getValue(string shape, "frameShape", string &frame);

shape.frameShape(string frame);

Parameter


Parameter	Description
shape	Name of the object
frame	The frame: "NoFrame "; //no frame "Box "; // rectangular box "Panel"; // rectangular panel "WinPanel"; // rectangular panel (Windows) "HLine "; // horizontal line "VLine "; // vertical line "StyledPanel "; // rectangular panel depending on the GUI style

Description

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).

Example

In the following example the style of a DpTree is set to "WinPanel" .

main(bool enter)
{
  string fs = "WinPanel";
  //set the type to WinPanel
  DP_TREE1.frameShape(fs);
}

Abbildung 1. DPTree with the frame type WinPanel

Assignment

TextEdit, Thumb wheel, Progress bar, Tree widget, Zoom navigator, LCD number, Embedded Module