.. highlightlang:: us

.. index:: ADDIN_AddToUI

.. _addin_addtoui:

ADDIN_AddToUI
=============

.. us.tag  ADDIN_AddToUI GERMAN New400

:ref:`ADDIN_AddToUI` trägt eine Funktion in die Benutzerschnittstelle ein. 

.. function::  b = ADDIN_AddToUI(nType, ssText, ssFunction)

.. us.return

**Returnwert**

*b* ist TRUE (1), wenn die Funktion erfolgreich war und sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: nType

   *nType* legt fest, für welche Gruppe von Kommandos eine Funktion
   zugefügt werden soll. *nType* kann einer der folgenden Typen sein:

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

      * - Name
        - Wert
        - Bedeutung
      * - ADDIN_FILE_IMPORT
        - 1
        - Datendatei-Importfunktionen
      * - ADDIN_DATA_MOREXYDATAFUNCTIONS
        - 2
        - Weitere 2D-Datensatzfunktionen
      * - ADDIN_DATA_MOREXYZDATAFUNCTIONS
        - 3
        - Weitere 3D-Datensatzfunktionen
      * - ADDIN_FILE_MOREFUNCTIONS
        - 4
        - Weitere Dateifunktionen
      * - ADDIN_LAYER_MOREFUNCTIONS
        - 5
        - Weitere Diagrammfunktionen
      * - ADDIN_LOAD_FUNCTIONS
        - 6
        - Weitere Datensatz-Importfunktionen

.. uparam:: ssText

   *ssText* ist ein beliebiger kurzer Text, der in der Benutzerschnittstelle
   angezeigt wird. 

.. uparam:: ssFunction

   *ssFunction* ist der Name der Funktion, die aufgerufen wird, wenn der Benutzer
   das entsprechende Kommando auswählt. Der Name wird ohne Klammern oder
   Parameter angegeben.

.. us.example

**Beispiel**

::

   ADDIN_AddToUI(ADDIN_FILE_IMPORT, "Excel - Spalten-Datei (*.xls)|*.xls|", "_DoImportExcelFile")

.. us.comment

**Kommentar**

ADDIN_FILE_IMPORT: Der Text des Parameters *ssText* wird im Typfeld des 
Datei-Öffnen Dialogs angezeigt. Der Suchfilter wird eingeschlossen in 
ODER-Zeichen am Ende des Textes angegeben. 
Beispiel: ``"Excel - Spalten-Datei (*.xls)|*.xls|"``. Die Funktion, die im
Parameter *ssFunction* angegeben wird, hat einen Parameter.

Eine Funktion für den Addin-Typ ADDIN_FILE_IMPORT soll den Namen der
erzeugten NC-Datei zurück geben. Falls die Funktion die angegebene Datei
nicht importieren kann, soll die Funktion einen leeren String zurück geben.
Falls ein Fehler auftritt soll die Funktion den Text ``"#IMPORTERROR#"`` zurück
geben. Beispiel für Import-Filter finden sie im Verzeichnis 
:file:`\\uniplot\\addin\\rs_fevis` oder :file:`\\uniplot\\addin\\rs_combi`.

ADDIN_LOAD_FUNCTIONS: Bei diesem Typ wird als Funktionsname nicht der
vollständige Name sondern nur der letzte Teil des Namens angegeben.
Siehe :ref:`GridLoadCallback_xxx`. Beispiel für Load-Funktionen
finden sie in der Datei :file:`\\uniplot\\script\\rs_loaddat.ic`). Ihren Filter
können sie in einer Datei mit der Endung :file:`.ic` im autoload-Verzeichnis
von UniPlot speichern.

ADDIN_DATA_MOREXYDATAFUNCTIONS, ADDIN_DATA_MOREXYZDATAFUNCTIONS,
ADDIN_FILE_MOREFUNCTIONS, ADDIN_LAYER_MOREFUNCTIONS: Bei diesen Typen
wird der vollständige Funktionsname angegeben. Die Funktion hat keine 
Parameter. Beispiele finden sie in der Datei :file:`\\uniplot\\script\\rs_xy.ic`.

.. seealso::
   :ref:`uberblick-programmierung`,
   :ref:`ADDIN_LoadAddIn`

:sub:`id-1939877`