4D Doc Center : ST Get text

Home

4D v14.3

ST Get text


ST Get text ( {* ;} Objekt {; StartAusw {; EndeAusw}} ) -> Funktionsergebnis

Parameter	Typ	Beschreibung
*	Operator	Mit Stern: Objekt ist ein Objektname (String), Ohne Stern: Objekt ist Variable oder Feld
Objekt	Formularobjekt	Mit : Objektname, ohne : Textfeld oder Variable
StartAusw	Lange Ganzzahl	Start der Auswahl
EndeAusw	Lange Ganzzahl	Ende der Auswahl
Funktionsergebnis	Text	Text mit Stil Tags

Beschreibung

Die Funktion ST Get text gibt den gefundenen formatierten Text im Textfeld oder der Variablen zurück, definiert im Parameter Objekt.

Mit dem optionalen Parameter * geben Sie an, dass der Parameter Objekt ein Objektname (String) ist. Hat das Objekt während der Ausführung den Fokus, gibt die Funktion Information über das Objekt in Bearbeitung zurück; hat das Objekt keinen Fokus, gibt die Funktion Information über die Datenquelle (Feld oder Variable) des Objekts zurück.

Ohne * geben Sie an, dass der Parameter Objekt ein Feld oder eine Variable ist. In diesem Fall übergeben Sie eine Feld- oder Variablenreferenz anstatt eines String. Die Funktion gibt während der Ausführung Information über dieses Feld oder diese Variable zurück.

Die Funktion gibt den Text mit den enthaltenen Stil Tags zurück. So können Sie z.B. Text mitsamt den Stilelementen kopieren und einsetzen.

Über die optionalen Parameter StartAusw und EndeAusw definieren Sie eine Auswahl des Textes in Objekt. Die Werte in StartAusw und EndeAusw geben eine Auswahl von Plain Text, ohne im Text gefundene Stil Tags zu berücksichtigen.

Lassen Sie StartAusw und EndeAusw weg, gibt ST Get text den gesamten Text von Objekt zurück
Übergeben Sie StartAusw und EndeAusw, gibt ST Get text den Volltext dazwischen zurück

Sind die Werte von StartAusw und EndeAusw gleich oder ist StartAusw größer als EndeAusw, wird ein Fehler zurückgegeben.

4D bietet vordefinierte Konstanten, so dass Sie die Auswahlgrenzen in den Parametern StartAusw und EndeAusw automatisch setzen können. Diese Konstanten finden Sie unter dem Thema Mehrfachstil Text:

Konstante	Typ	Wert	Meldung
ST End highlight	Lange Ganzzahl	-1001	Bestimmt das letzte Zeichen der aktuellen Textauswahl in Objekt (*)
ST End text	Lange Ganzzahl	0	Bestimmt das letzte Zeichen des Textes in Objekt
ST Start highlight	Lange Ganzzahl	-1000	Bestimmt das erste Zeichen der aktuellen Textauswahl in Objekt (*)
ST Start text	Lange Ganzzahl	1	Bestimmt das erste Zeichen des Textes in Objekt

(*) Für diese Konstante müssen Sie in Objekt einen Objektnamen übergeben. Übergeben Sie eine Referenz auf ein Feld oder eine Variable, wird die Funktion auf den gesamten Text des Objekts angewandt.

Systemvariablen und Mengen

Nach Ausführen dieses Befehls wird die Variable OK auf 1 gesetzt, wenn kein Fehler aufgetreten ist; andernfalls wird sie auf 0 gesetzt. Das ist insbesondere der Fall, wenn Stil Tags nicht korrekt gewertet werden (inkorrekte oder fehlende Tags).

Bei einem Fehler wird die Variable nicht geändert. Tritt ein Fehler in einer Variablen auf, während der Text gewertet wird, wandelt 4D den Text in Plain Text um; als Ergebnis werden die Zeichen <, > und & in HTML Einheiten umgewandelt.