2.19 :gettext()

Die Methode :gettext() liefert Text aus dem Inhalt eines Edittextes zurück.

Definition

string :gettext
(
  { integer Start input,
    integer End   := -1 input, }
  { enum    Type  := content_plain input }
)

Parameter

integer Start input
integer End := -1 input

Mit diesen optionalen Parametern wird der Bereich definiert, dessen Text zurückgegeben werden soll. Wenn kein Bereich angegeben ist, wird der Text von .startsel bis .endsel zurückgegeben, also der Inhalt der Selektion.

Der Wertebereich von Start und End geht von 0 bis zur Anzahl der Zeichen im angezeigten Text, wobei jedes Zeichen zählt, das in eine Selektion eingeschlossen werden kann. Zeilenumbruch-Zeichen zählen daher mit.

Für End kann -1 angegeben werden, um den restlichen Text ab der Startposition zu erhalten.

Beim RTF-Edittext (.options[opt_rtf] = true) beziehen sich Start und End – analog zu .startsel und .endsel – auf Positionen im formatierten Text. Aus ihnen kann nicht auf Positionen im Content-String des RTF-Edittextes geschlossen werden, da dieser zusätzlich Formatierungsanweisungen enthält. Sind die Parameter Start oder End größer als die Textlänge, dann wird beim RTF-Edittext die Textlänge verwendet.

enum Type := content_plain input

Mit diesem optionalen Parameter kann beim RTF-Edittext festgelegt werden, ob der Inhalt des Textbereichs als unformatierter, reiner Text („Plain Text“) oder als RTF inklusive der Formatierungsanweisungen zurückgegeben wird.

Wertebereich

content_plain

String enthält reinen, unformatierten Text.

content_rtf

String enthält RTF-Text.

Nur verwendbar bei .options[opt_rtf] = true.

Rückgabewert

String mit dem Inhalt des angegebenen Textbereichs.

Objekte mit dieser Methode

edittext