CONTROL
- Introduction to CTRL
- CONTROL Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
    - abortFileTransfer()
      The function abortFileTransfer() aborts all file transfers of the stated manager.
    - abs()
      Returns the absolute value of a value.
    - access()
      Queries the access mode of the file or directory with the specified path name.
    - acGetRefACType()
      Returns a AC type name, if the leaf dpeName is referenced to an AC type, otherwise an empty string.
    - acos()
      Returns the arc cosine in the radian measure.
    - activateMode()
      Switches the module to normal operating mode.
    - addGlobal()
      Creates a variable and makes it into a control-wide variable.
    - addGroup()
      Adds a group of shapes or a layout to a panel.
    - addGroupPVSS()
      Adds a user group of an external authentication system to the WinCC OA user administration.
    - addShape()
      Adds a new shape into a panel.
    - addSymbol()
      Adds a panel reference in a panel or layout at a later time during run time. To suppress the Initialize scripts of the reference the function createSymbol() can be used instead.
    - addUserPVSS()
      Adds a user of an external authentication system to the WinCC OA user administration.
    - addUserToGroupPVSS()
      Adds a WinCC OA user to a user group in the WinCC OA user administration.
    - aes256Decrypt()
      The function allows to decrypt an encrypted information with the AES-256 algorithm.
    - aes256Encrypt()
      The function allows to encrypt the passed information with the AES-256 algorithm.
    - afterLogin()
      After successful login displays the required panel.
    - alertConnect()
      Registers the function work() for call with resulting alerts.
    - alertDisconnect()
      Unregisters the function work() from call when changes are made to the values.
    - alertGet()
      Queries only the last alert attributes of a data point.
    - alertGetPeriod()
      Reads the values of the specified alert attributes of the data point elements for which alerts were triggered.
    - alertSet()
      Allows data point attributes to be set in a similar way to dpSet().
    - alertSetTimed()
      Allows data point attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.
    - alertSetTimedWait()
      Allows data point attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.
    - alertSetWait()
      Allows data point attributes to be set in a similar way to alertSet()/dpSetWait().
    - animate()
      With the function animate() you can create animations.
    - animateWait()
      With the function animateWait() you can create animations and wait for them to finish.
    - asin()
      Returns the arc sine in the radian measure.
    - assignPtr()
      The function allows to assign a shared_ptr to a different shared_ptr..
    - atan()
      Returns the arc tangent in the radian measure.
    - atan2()
      Returns the arc tangent of the Cartesian coordinates y and x.
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.
- CtrlExtension, basics
- CTRLPPCheck
  Save time and money with increased code quality in your projects

addShape()

Adds a new shape into a panel.

Synopsis

shape addShape(shape panel, int layer, string shapeType, string shapeName);

shape addShape(string moduleName, string panelName, int layer, string shapeType, string shapeName);

Parameter


Parameter	Description
panel	Panel as shape object to which the shape should be added.
layer	Layer in which the shape should be added.
shapeType	Type of the shape, see "shapeType"
shapeName	Name of the shape.
moduleName	Name of the module in which the shape should be added.
panelName	Name of the panel in which the shape should be added.

Return Value

The function returns a pointer to the newly created shape.

In case of an error a 0 shape is returned.

Errors

Missing arguments in the function, unknown module or panel, illegal layer, unknown shapeType.

Description

Adds a new shape instance into the given panel. The panel can either be addressed by a "shape" pointer, e.g.

shape panel = getShape("Module.Panel:");

or via moduleName/panelName as string.

The returned shape can be used to directly set additional values into the shape.

Active-X shapes on Windows can currently not be added via addShape()
The given shapeName is currently not checked for duplicate name entries in the addressed panel.
After adding the object it has no defined size. It is recommended to set it directly using the property "points".

Assignment

Graphics function

Availability

UI, CTRL