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.
Administration of Managers, Modules and Panels - Functions
isUltralight()
The function returns TRUE if it is executed from a ULC UX client.

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
    - activateMode()
      Switches the module to normal operating mode.
    - confirmMode()
      Switches the module to individual acknowledge mode.
    - convManIdToInt()
      Returns an integer that corresponds to the ManagerIdentifier.
    - convManIntToName()
      Converts an integer, which corresponds to the manager identifier, to manager name.
    - enableMenuItem() - obsolete
      Supports disabling of menus (obsolete from version 3.5 up).
    - getConfirmDps()
      Returns an array with the datapoints of a panel to be acknowledged.
    - getGediNames()
      Returns the opened modules of the type GEDI.
    - getInitialZoomFactor()
      Returns the defined zoom factor that scales all panels (even childpanels) after the start of a UI.
    - getManIdFromInt()
      Converts manager ID into manager type and manager number.
    - getPath()
      This function determines the absolute paths for panels, scripts etc.
    - getRcvLevel()
      The function returns the receive debug level for messages.
    - getScaleStyle()
      Returns the configured scale style of the module for zooming.
    - getSndLevel()
      The function returns the send debug level for messages.
    - getVisionNames()
      Outputs all the open Vision modules.
    - getZoomFactor()
      Reads the zoom factor for a panel.
    - getZoomRange()
      Returns the minimum and maximum value that can be used while zooming.
    - isConnActive()
      The function checks whether the connection to the event manager is active. The function is used in split mode to determine the active EM connection. The host the user interface is logical connected to is shown in the system overview. See chapter System overview with redundancy.
    - isConnOpen()
      The function checks if the connection from the own user interface manager to the event manager exists. The function is used in a redundant system. With this function, you can find out to which event manager the UI is connected to (to the left or to the right).
    - isDbgFlag()
      Queries if a flag with the defined name or number has been set.
    - isDistributed()
      The function returns TRUE if the entry distributed = 1 exists for the manager in the config file. If the entry distributed in the config file is not 1, FALSE will be returned. In case of a remote UI, the distributed entry is set by the Data Manager when distributed = 0/1 does not exist in the file. In this way, also other systems than the own local system can be accessed.
    - isInBrowser()
      Verifies whether the UI Manager is running in the Web Client plugin inside the web browser.
    - isModeExtended()
      This function returns whether the Vision has been opened in extended mode (configuration mode) or not.
    - isModuleOpen()
      Specifies whether a particular module is open.
    - isPanelOpen()
      The function returns whether a particular panel is open.
    - isRedundant()
      This function returns whether the project has been configured as redundant.
    - isRemoteSystemRedundant()
      This function returns whether the project has been configured as redundant.
    - isUltralight()
      The function returns TRUE if it is executed from a ULC UX client.
    - moduleOriginalSize()
      Resizes the panel to its original size.
    - moveModule()
      Moves a module to an arbitrary position on the screen.
    - myManId()
      Returns the manager ID as a number. The number contains coded the system, replica, type and number.
    - myManNum()
      Returns the manager number of the UI manager.
    - myModuleName()
      Returns the name of the current module.
    - myPanelName()
      Returns the name of the current panel.
    - myUiNumber()
      Returns the number of the UI manager.
    - myWindowId()
      Returns the identification number of the current window.
    - panelSize()
      Returns the width and height of a panel.
    - panelZoomIn()
      Zooms in the rootpanel in a module around the center with the specified zoom factor.
    - panelZoomOut()
      Zooms out the rootpanel in a module around the center with a specified zoom factor.
    - panningMode()
      Activates or deactivates the function for displacing the root panel in a module.
    - printRootPanel()
      Prints a particular root panel.
    - registerDbgFlag()
      Registers a debug flag and returns a debug flag number.
    - rootPanel()
      Returns the name of a particular root panel.
    - setClutteringLimits()
      This function is used for defining the zoom factor to show/hide layers (cluttering/decluttering) in individual panels.
    - setPanelSize()
      Sets a child panel or a module (panel as a module) to a defined size.
    - setReportFlags()
      Triggers the report output with the specified debug flags.
    - setScaleStyle()
      Sets the scale style of the module for zooming.
    - setSndLevel()
      The function sets the send debug level for messages.
    - setRcvLevel()
      The function sets the receive debug level for messages.
    - stayOnTop()
      The function places the specified module above all non-topmost windows. The window of the module maintains its topmost position even when it is deactivated.
    - titleBar()
      Shows or hides the title bar in the specified module or in a child panel.
    - trackZoomMode()
      Complies with the function "Rubber band zoom". After calling this function a cursor "cross" is displayed, which allows to create a window by left-clicking. The panel is scaled in accordance with the specified window size.
  - Alert Handling Functions
    These functions are associated with datapoints and respond to alerts and changes to alerts.
  - AlertService Functions
    These functions provide alarm shelving, suppression, and out-of-service capabilities via the AlertServiceClient class.
  - Blob Functions
  - Communication functions
  - Connection Functions
    Connection functions can be used to establish connections to alerts, datapoints and system events.
  - Crypthographic Functions
  - Database Functions
  - Datapoint Functions
  - Error Functions
  - File Functions
    File functions allow you to import, export, open, close, and manipulate files within the application. This topic describes how to use file functions and important considerations for cross-platform compatibility.
  - Graphics Functions
  - Help Viewer Functions
    Available Functions for the Help Viewer.
  - HTTP Functions
  - Input Event Recorder Functions
  - Licensing Functions
  - Mapping Functions
  - Mathematical Functions
  - MindSphere Connector Functions
  - Miscellaneous Functions
  - Multilingual Functionality
  - Project administration Functions
  - Query Functions
  - Redu/Dist Functions
  - Selection and Configuration Dialogs - Functions
  - Semaphore Functions
  - String Functions
  - Subscription-based Licensing Functions
    CONTROL functions for querying information from subscription-based licenses.
  - System Tray
  - 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.
  - 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 datapoints 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.
eLearning
Build Your Expertise Step by Step
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.
SIMATIC WinCC OA World
Explore the World of WinCC OA and Stay updated with the latest product news

isUltralight()

The function returns TRUE if it is executed from a ULC UX client.

Synopsis

bool isUltralight();

Return value

Returns TRUE when called from a ULC UX client; otherwise returns FALSE.

Description

This function returns TRUE when called from a ULC UX client client, and FALSE when called from any other client.

Assignment

Administration of Managers, Modules and Panels - Functions

Availability

UI, CTRL