Home
Business Logic / Control
Endless possibilities in data processing for your projects.
Types of Control Functions
An overview of the types of functions distinguished within Control.
Window Functions
This chapter lists all functions used to control windows and panels, such as ChildPanelOn, LayerOn, LayerOff, PanelOff, RootPanelOn, SwitchLayer, ZoomModule, and related dialog and module operations.
RootPanelOnModule()
Opens a panel in a particular module.

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.
  - 32/64 bit Functions
  - Administration of Managers, Modules and Panels - Functions
  - Alert Handling Functions
    These functions are associated with data points and respond to alerts and changes to alerts.
  - Blob Functions
  - Communication Functions
  - Connection Functions
    Connection functions can be used to establish connections to alerts, data points and system events.
  - Crypthographic Functions
  - Database Functions
  - Data point Functions
  - Error Functions
  - File Functions
  - Graphics Functions
  - Help Viewer Functions
    Available Functions for the Help Viewer.
  - Input Recording Functions
  - Mapping Functions
  - Mathematical Functions
  - MindSphere Connector Functions
  - Miscellaneous Functions
  - Multilingual Functionality
  - Project administration Functions
  - Query Functions
  - Redu/Dist Functions
  - Reference - Focus Policy - Functions
  - Selection and Configuration Dialogs - Functions
  - Semaphore Functions
  - String Functions
  - Time Functions
  - Threads Functions
  - User Administration Functions
  - Vector / Dynamic arrays - Functions
  - Waiting Control Functions
  - Window Functions
    This chapter lists all functions used to control windows and panels, such as ChildPanelOn, LayerOn, LayerOff, PanelOff, RootPanelOn, SwitchLayer, ZoomModule, and related dialog and module operations.
    - ChildPanelOn()
      Opens a child panel.
    - ChildPanelOnCentral()
      Opens a child panel centered in the calling parent panel.
    - ChildPanelOnCentralModal()
      Opens a modal child panel centered in the calling parent panel.
    - ChildPanelOnCentralModalReturn()
      Opens a modal child panel, with return value, centered in the calling parent panel.
    - ChildPanelOnCentralReturn()
      Opens a child panel with return value centered in the calling parent panel.
    - ChildPanelOnModal()
      Opens a modal child panel at the position x, y.
    - ChildPanelOnModalReturn()
      Opens a modal child panel with return values at the position x,y.
    - ChildPanelOnModule()
      Opens a child panel in an arbitrary module.
    - ChildPanelOnModuleCheckPos()
      Opens a child panel and also checks the validity of the position and size.
    - ChildPanelOnModuleModal()
      Opens a modal child panel in the module "ModuleName".
    - ChildPanelOnModuleModalReturn()
      Opens a modal child panel in the module "ModuleName" with a return value.
    - ChildPanelOnModuleReturn()
      Opens a child panel in the module "ModuleName" with return values.
    - ChildPanelOnParent()
      Opens a child panel in the specified panel.
    - ChildPanelOnParentModal()
      Opens a modal child panel in the specified panel.
    - ChildPanelOnParentModalReturn()
      Opens a modal child panel in the specified panel with return values.
    - ChildPanelOnParentReturn()
      Opens a child panel in the specified panel with return values.
    - ChildPanelOnRelativ()
      Opens a child panel relative to the calling object.
    - ChildPanelOnRelativModal()
      Opens a modal child panel relative to the calling object.
    - ChildPanelOnRelativModalReturn()
      Opens a modal child panel relative to the calling object, with a return value.
    - ChildPanelOnRelativReturn()
      Opens a child panel with a return value, relative to the calling object.
    - ChildPanelOnReturn()
      Opens a child panel with return values.
    - ChildPanelReturnValue()
      Opens a child panel of a particular type with a return value.
    - LayerOff()
      Hides a layer.
    - LayerOffPanel()
      Hides a layer in a particular panel.
    - LayerOffPanelInModule()
      Hides a layer in a particular panel and module.
    - LayerOn()
      Displays a layer.
    - LayerOnPanel()
      Displays a layer in a particular panel.
    - LayerOnPanelInModule()
      Display a layer in a particular panel and particular module.
    - LoginDialog()
      The function is used by LogoutDialog() to start the login dialog.
    - LogoutDialog()
      The function is used to open the logout dialog and to go to a new login dialog.
    - ModuleOnWithPanel()
      This function opens a new module containing the specified root panel in the right size.
    - PanelOffModule()
      Closes a panel in a specific module.
    - PanelOffPanel()
      Closes a particular panel
    - PanelOffReturn()
      Needed for closing a child panel with a return value.
    - PasswordDialog()
      Opens a dialog for changing the password of the current user.
    - PanelOff()
    - panelOff()
      Closes a defined childpanel without connection to the Event Manager.
    - ptms_LoadOneBasePanel()
      If two base panels are started on two monitors and the base panel will be closed on one of the monitors, the function ptms_LoadOneBasePanel can be used to reopen the base panel on this monitor.
    - restorePanel()
      Opens an already loaded child panel that had been minimized.
    - RootPanelOn()
      Opens a new panel in the current module.
    - RootPanelOnModule()
      Opens a panel in a particular module.
    - SwitchLayer()
      Switches the visibility of two layers.
    - SwitchLayerPanel()
      Switches the visibility of two layers in a specific panel.
    - SwitchLayerPanelInModule()
      Switches the visibility of two layers in a specific panel and module.
    - ZoomModule()
      Zooms the content of the UI module and resets the position of the panel in the module.
  - Window Functions
    This chapter lists all functions used to control windows and panels, such as ChildPanelOn, LayerOn, LayerOff, PanelOff, RootPanelOn, SwitchLayer, ZoomModule, and related dialog and module operations.
  - XML Control Extension Functions
- Control graphics
- 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.
- WinCC OA JavaScript Manager for Node.js
  The WinCC OA JavaScript Manager for Node.js is a manager that allows for the integration of the TypeScript/JavaScript runtime environment Node.js® into WinCC OA.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
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.
Documentation
Basic information about terms and functions within the documentation.
Support & Services
An experienced team of support agents, consultants and trainers are ready to facilitate active partnerships with our customers, so they can profit from our comprehensive service.
Disclaimer
A brief clarification of liability exclusions or legal notices.

RootPanelOnModule()

Opens a panel in a particular module.

Synopsis

RootPanelOnModule( string FileName, string PanelName, string ModuleName, dyn_string Parameter );

Parameters


Parameter	Description
FileName	File name of the panel to open
PanelName	Name of the panel to open
ModuleName	Name of the module in which the panel opens
Parameters	List of $parameters to be transferred

Return value

Error

Description

In the module ModuleName, opens a panel PanelName that is saved under the name Filename. When called, the list Parameters containing the $ parameters will be transferred.

Example

main()
{
  RootPanelOnModule("diverse", "P1", myModuleName(), "");
}

Assignment

panel.ctl