.. highlightlang:: us

.. index:: auto_AddToUI

.. _auto_addtoui:

auto_AddToUI
============

.. us.tag  auto_AddToUI ENGLISH

:ref:`auto_AddToUI` adds a UniScript
function to UniPlot's user interface. The function will be added to the
Report Menu to the specified category.

.. function::  bool = auto_AddToUI(ssCategory, ssDescription, ssFunctionName)

.. us.params

**Parameters**

.. uparam:: ssCategory

   The parameter *ssCategory* can be used to organize
   reports. If the specified category *ssCategory* does not exist, a new
   menu item will be added to the Report Menu. The maximum number of categories
   is limited to 16.

.. uparam:: ssDescription

   The parameter *ssDescription* is a scalar string
   with a short description of the function *ssFunctionName*. The description
   will be displayed in a listbox when a item in the Report Menu was chosen.

.. uparam:: ssFunctionName

   *ssFunctionName* is the name of the function
   which will be called if the user selects a report from the Report Menu.
   This function should not have any parameters. The function name is given
   without parentheses ``"()"``.

.. us.example

**Example**

::

   auto_AddToUI("WOT", "WOT-Report (Torque, Power, Fuel)", "RS_WOT_1");

   def RS_WOT_1()
   {
       auto_LoadTemplate("tpl_ger");

       // More auto_-Functions here.

       auto_UpdatePage();
   }

.. seealso::
   :ref:`overview-automation`

:sub:`id-133184`