.. highlightlang:: us

.. _auto_replacetextdialog:

auto_ReplaceTextDialog
======================

.. index:: auto_ReplaceTextDialog

.. us.tag  auto_ReplaceTextDialog NOTREADYGERMAN DialogBoxes Changed540

:ref:`auto_ReplaceTextDialog` kann
innerhalb eines Automatisierungs-Skripts verwendet werden, um ein
Text-Dialogfeld anzuzeigen.

.. function::  bool = auto_ReplaceTextDialog()
    bool = auto_ReplaceTextDialog(hPage)
    bool = auto_ReplaceTextDialog(ssNetCDFName)
    bool = auto_ReplaceTextDialog(hPage, ssNetCDFName)
    bool = auto_ReplaceTextDialog(ncid)
    bool = auto_ReplaceTextDialog(hPage, ncid)

.. us.return

**Returnwert**

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

.. us.params

**Parameter**

.. uparam:: hPage

   *hPage* ist die Zugriffsnummer der Seite, in der die
   Texte bearbeitet werden sollen. Wird dieser Parameter nicht angegeben
   oder der Wert 0 angegeben, wird die aktive Seite verwendet. Die aktive
   Seite ist die momentan auf dem Monitor zu oberst sichtbare Seite.

.. uparam:: ssNetCDFName

   *ssNetCDFName* ist der vollständige Dateiname der
   netCDF-Datei (:file:`.NC`).

.. uparam:: ncid

   *ncid* ist die Zugriffsnummer, die von einem erfolgreichen Aufruf der 
   Funktionen :ref:`nc_create` oder :ref:`nc_open` geliefert wurde. 

.. us.comment

**Kommentar**

Wird die Funktion ohne den Parameter *hPage* aufgerufen, wird
die Funktion auf die Seite angewendet, die mit Hilfe der Funktion
:ref:`auto_LoadTemplate` erzeugt wurde.

Die Funktion sucht in der Seite nach Platzhaltern. Ein Platzhalter ist
ein Text, der in ``$``-Zeichen eingeschlossen ist, z. B. ``$Bearbeiter$``. 
Für alle gefundenen Platzhalter wird im Dialog ein
Textfeld angezeigt. Die Platzhalter können sich in Text-Objekten oder
in den Achsentiteln der Diagramme befinden.

Falls im Text eines Text-Objektes kein Platzhalter gefunden wird, sucht die
Funktion auch im Namen des Text-Objektes nach einem Platzhalter. Falls im
Namen des Textobjektes ein Platzhalter gefunden wird, so wird der Text des
Textobjekts im Dialog für die Bearbeitung angezeigt.

Wenn der Parameter *ssNetCDFName* angegeben wird, wird zuerst in der
NC-Datei nach den Platzhaltern gesucht. Dabei ist folgendes zu
beachten:

Um auf ein globales Attribut zuzugreifen, wird der Name des Attributs
angegeben. Beispiel: ``"Origin"``.

Um auf ein Attribut einer bestimmten Variablen zuzugreifen, wird der
Name der Variablen durch einen Punkt vom Attributnamen getrennt.
Beispiel: ``$Mom.long_name$``.

Groß- und Kleinschreibung wird unterschieden.

Platzhalter, die in der NC-Datei gefunden wurden, werden im Dialogfeld
durch ein vorangestelltes Sternchen ``"*"`` markiert.

Siehe auch: :ref:`text-placeholder`.

.. image:: S:/uniplot-obj/images/auto_TextDialog-en.*

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - 5.4.0
     - Anstatt des Names der NC-Datei kann nun auch der Parameter *ncid* übergeben werden.

.. seealso::
   :ref:`uberblick-automatisierung-der-diagrammerstellung`,
   :ref:`auto_ReplaceText`,
   :ref:`auto_ReplaceTextFromNCFile`,
   :ref:`auto_GetFileNameDialog`,
   :ref:`auto_ImportData`
   :ref:`text-placeholder`

:sub:`id-1813745`