.. highlightlang:: us

.. index:: OnCommandUI
.. index:: UI

.. _oncommandui:

OnCommandUI
===========

.. us.tag  OnCommandUI GERMAN Menu New300

Der Funktionsname :ref:`OnCommandUI` steht für den Namen einer
Funktion, die durch ein Menü oder einen Schalter einer Schalterleiste
aufgerufen wird.

.. function::  svUI = OnCommandUI()

.. us.return

**Returnwert**

*svUI* ist ein String-Vektor mit einem oder mehreren Elementen
der folgenden Liste:

.. list-table::
   :header-rows: 1

   * - Wert
     - Bedeutung
   * - ``""``
     - Der Menüeintrag wird normal angezeigt.
   * - ``"@g"`` oder ``"@grayed"``
     - Der Menüeintrag wird grau angezeigt und ist nicht auswählbar.
   * - ``"@h"`` oder ``"@hide"``
     - Der Menüeintrag wird nicht angezeigt.
   * - ``"@c"`` oder ``"@checked"``
     - Der Menüeintrag wird mit einem Häckchen versehen.
   * - ``"text"``
     - ``"text"`` steht für den Menütext, der ausgegeben werden soll.

.. us.comment

**Kommentar**

Der Funktionsname setzt sich aus dem Namen der :ref:`OnCommand` Funktion
und dem Buchstaben **UI** zusammen. Die Funktion wird vom Rahmenprogramm
aufgerufen.

.. us.example

**Beispiel**

Die folgende "UI"-Funktion prüft, ob die Funktion
**OnXY_Fit** geladen ist. Falls dies nicht der Fall ist,
wird der Menüpunkt nicht angezeigt.

::

   def OnXY_FitUI()
   {
       if (!IsFunctionLoaded("OnXY_Fit")) {
           return "@hide";
       }
       return "";
   }

.. seealso::
   :ref:`uberblick-menus`,
   :ref:`OnCommand`

:sub:`id-1012446`