.. highlightlang:: us

.. index:: Überblick Feldfunktionen, Feldfunktionen 

.. _overview-field-functions:
.. _uberblick-feldfunktionen:

Überblick Feldfunktionen
========================

.. us.makeindex   fieldfunction, Liste der Feldfunktionen

.. include:: ../ftab/fieldfunction.ftab

**Schreiben eigener Feldfunktionen**

Es können eigene Feldfunktionen definiert werden. Das folgende Beispiel zeigt
die Feldfunktion ``@f{pagename}``. Der Name der Feldfunktion muss
mit dem Prefix ``__ff_`` beginnen (2 Unterstriche gefolgt von den
Zeichen ``ff`` gefolgt von einem Unterstrich). Der Funktionname darf nur 
Kleinbuchstaben enthalten. Die Parameterliste
der Funktion muss mit dem Beispiel übereinstimmen. Optionale Aufruf-
Parameter werden in dem String-Vektor ``svParameter`` übergeben.
Es können nur Zeichenketten übergeben werden. Die Funktion muss einen
skalaren String zurückgeben. Im Fehlerfall soll die Funktion einen
leeren String (``""``) zurückgeben.

Für die benutzerdefinierten Feldfunktionen sollte eine eigene
IC-Datei erzeugt werden, die im Autoload-Verzeichnis 
(:file:`uniplot\\autoload`) gespeichert werden sollte. Die in diesem
Verzeichnis gespeicherten IC-Dateien werden beim Start von UniPlot
automatisch geladen.

Der Parameter *hText* enthält die Zugriffsnummer des Textobjektes, in dem sich
die Feldfunktion befindet. Der Parameter *hLayer* enthält die Zugriffsnummer des
Diagramms, in dem sich das Textobjekt *hText* befindet. Der Parameter *hPage*
enthält die Zugriffsnummer der Seite und *hDoc* die Zugriffsnummer des
Dokuments, in dem sich das Textobjekt befindet.

Der Parameter *nAction* wird z. Z. noch nicht verwendet.

**Beispiel**:

::

   def __ff_pagename(hDoc, hPage, hLayer, hText, nAction, svParameter)
   {
       if (hPage != 0) {
           return PageGetTitle(hPage);
       }
       return "";
   }

Weiter Beispiele finden Sie im Verzeichnis :file:`uniplot\\script\\field`.

.. seealso::
   :ref:`funktionen-eingeteilt-in-kategorien`

:sub:`id-1133232`