Jump to main content
WinCC OA Documentation
WinCC OA Documentation
LANG
  • Versionsinformationen
  • Konzepte
  • Deployment
  • Sicherheit
  • Engineering
  • Datenmanagement
  • Business Logic / Control
  • Datenvisualisierung
  • Southbound Interfaces
  • Northbound Interfaces
  • Konnektivität / Netzwerk Schnittstellen
  • Benutzerverwaltung
  • Verfügbarkeit
  • Reporting
  • Erweiterungen
  • Referenztabellen
  • Videos & Tutorials
  • eLearning
  • Dokumentation
  • Support & Services
  • Disclaimer
  • SIMATIC WinCC OA World
  1. Home
  2. Business Logic / Control

    Endlose Möglichkeiten in der Datenverarbeitung für Ihre Projekte.

  3. Types of Control Functions

    An overview of the types of functions distinguished within Control.

  4. Administration of Managers, Modules and Panels - Functions
  5. isUltralight()

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

  • Versionsinformationen

    Release Notes, Update-Informationen, Zertifizierungen and häufig gestellte Fragen.

  • Konzepte

    Ihr erster Schritt in die moderne und leistungsstarke Prozessvisualisierung.

  • Deployment

    Themen, die Sie vor der Nutzung von WinCC OA wissen sollten.

  • Sicherheit

    Wachsen sie in Bezug auf Cybersecurity über die Norm hinaus.

  • Engineering

    Leistungsstarke Tools für einfache sowie komplexe Engineering-Aufgaben.

  • Datenmanagement

    Klassifizieren, strukturieren und archivieren sie Ihre Daten.

  • Business Logic / Control

    Endlose Möglichkeiten in der Datenverarbeitung für Ihre Projekte.

    • 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

        You can use these functions to import and export files, open, close files as well as perform other file manipulations.

      • 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

        These functions are used for handling languages, texts and message catalogs in multilingual projects.

      • Project administration Functions
      • Query Functions
      • Redu/Dist Functions
      • Selection and Configuration Dialogs - Functions
      • Semaphore Functions
      • String Functions

        These functions read and edit strings or parts of strings.

      • Funktionen für abonnementbasierte Lizenzen

        CONTROL-Funktionen zum Abfragen von Informationen aus abonnementbasierten Lizenzen.

      • System Tray
      • Time Functions
      • Threads Functions
      • User administration Functions
      • Vector / Dynamic arrays - Functions
      • Waiting Control Functions

        These Control functions block the execution of a script until a response is received from the Event Manager.

      • 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

        The XML Control Extension allows to operate on XML data via the CTRL scripting language.

    • Control Graphics
    • CONTROL Functions
    • CtrlExtension

      Die CtrlExtension ermöglicht das Hinzufügen von benutzerdefiniertem C++-Code.

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

    • SQL in CONTROL

      Mit den Datenbankfunktionen besteht eine Möglichkeit, Werteabfragen von Datenpunkten und -elementen schnell durchzuführen.

    • WinCC OA JavaScript Manager für Node.js

      Der WinCC OA JavaScript Manager für Node.js ist ein Manager, welcher die Einbindung der TypeScript/JavaScript Runtime-Umgebung in WinCC OA erlaubt.

    • API Manager

      Das API von WinCC OA (Application Programming Interface) bietet eine Reihe von Funktionen, die es ermöglichen, dieses Prozessleitsystem um spezielle Manager zu erweitern.

  • Datenvisualisierung

    User Interfaces, Trends und Reports für jeden Zweck und jedes Gerät.

  • Southbound Interfaces

    Der Prozessanschluss zu den echten Maschinen/Sensoren.

  • Northbound Interfaces

    Ihr Portal zur Cloud oder übergeordneten Systemen.

  • Konnektivität / Netzwerk Schnittstellen

    Datenaustausch, APIs und moderne (Web) Technologien.

  • Benutzerverwaltung

    Alles über Autorisierung, Authentifizierung und Login-Anpassung.

  • Verfügbarkeit

    Wie sie maximale Systemverfügbarkeit erreichen können.

  • Reporting

    Erstellen sie "State of the art"-Reports ohne Limits.

  • Erweiterungen

    Nützliche Werkzeuge und Erweiterungen für spezielle Anforderungen.

  • Referenztabellen

    Detaillierte und umfangreiche Inhalte für spezielle Projektanpassungen.

  • Videos & Tutorials

    Erkunden Sie die Möglichkeiten von WinCC OA mit unserer sorgfältig ausgewählten Sammlung von Video-Tutorials und Anleitungen.

  • eLearning

    Bauen Sie Ihre Expertise Schritt für Schritt auf

  • Dokumentation

    Grundlegende Informationen über Bezeichnungen und Funktionsweisen innerhalb der Dokumentation.

  • Support & Services

    Ein erfahrenes Team von Support-Mitarbeitern, Beratern und Trainern steht bereit, aktive Partnerschaften mit Kunden zu fördern, die von unserem umfassenden Service profitieren.

  • Disclaimer

    Erläuterungen zu Haftungsausschlüssen oder rechtlichen Hinweisen.

  • SIMATIC WinCC OA World

    Entdecken Sie die Welt von WinCC OA und bleiben Sie über die neuesten Produktneuigkeiten informiert.

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

On this page
  • Synopsis
  • Return value
  • Description
  • Assignment
  • Availability

SIMATIC WinCC Open Architecture Version 3.21.6 - © ETM professional control GmbH - | | | - Privacy Policy - Cookie Policy - Terms of use - Whistleblowing - Imprint