2.42 :setformat()

boolean :setformat
(
  { integer  Start := 1  input,
    integer  End   := -1 input, }
    enum     Type  input,
    anyvalue Value input
)

Parameter

integer Start := 1 input
integer End := -1 input

Mit diesen optionalen Parametern wird der Bereich definiert, der formatiert werden soll. Fehlen diese Angaben, wird der Bereich von .startsel bis .endsel (Selektion bzw. Cursorposition) formatiert.

Welcher Bereich tatsächlich formatiert wird, hängt von der Art der Formatierung ab:

• Zeichenformatierungen wirken sich genau auf den angegebenen Bereich aus.
• Absatzformatierungen wirken sich auf alle Absätze aus, die ganz oder teilweise im angegebenen Bereich enthalten sind.

Die Formatierungsart ist in der nachfolgenden Tabelle mit angegeben.

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 formatieren.

Start und End beziehen sich – 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 input

Dieser Parameter definiert den Typ der Formatierung, die angewendet werden soll. Die enum-Werte für die Formatierungstyen sind in der nachfolgenden Tabelle aufgelistet.

anyvalue Value input

In diesem Parameter wird ein Wert übergeben, der die Ausprägung des in Type definierten Formatierungstyps festlegt. Die Datentypen für die Formatierungstypen sind in der nachfolgenden Tabelle mit angegeben.

Rückgabewert

true

Der Textbereich wurde formatiert.

false

Fehler: Die Formatierung konnte nicht angewendet werden (z.B. wegen fehlerhafter Argumente).

Formatierungsarten, enum-Werte und Datentypen der Formatierungstypen

Je nach Schriftart kann es vorkommen, dass Formatierungsanweisungen bzw. mit :setformat() gesetzte Formatierungsattribute vom Windows-Objekt, das der IDM für den RTF-Edittext verwendet, nicht beachtet werden. Unter Windows 7 ist dies zum Beispiel bei text_bold so, wenn explizit keine Schriftart gesetzt und daher implizit die Schriftart System verwendet wird.

Maßeinheit für Größen und Positionen

Größen und Positionen werden – wie bei der Windows-Programmierung üblich – in twips angegeben. Ein twip entspricht 1/20 point (Punkt), das ist 1/1440 Zoll (inch) bzw. 1/567 cm.

Erläuterungen zu einzelnen Formatierungen

• Der Wert für text_indent_right ist eine absolute Angabe der Einrückung vom rechten Rand.
• Dagegen ist text_indent_left eine relative Angabe, die mehrfach angewendet werden kann. Die Einrückungen vom linken Rand werden akkumuliert, können insgesamt aber nie über den Rand hinausgehen. Der Wert kann negativ sein und bedeutet dann eine Verschiebung eines Absatzes nach links, während positive Werte eine Verschiebung nach rechts bedeuten.
• Der Wert von text_indent_offset gibt an, wie weit alle Zeilen eines Absatzes außer der ersten gegenüber der ersten Zeile nach rechts (positiver Wert) oder nach links (negativer Wert) verschoben sind.

• Bei text_font kann

  • ein String mit einem Fontnamen,
  • ein String mit Größe und Fontnamen in der Form <size>.<font name>, analog zu font-Ressourcen unter Microsoft Windows, oder
  • eine font-Ressource

  angegeben werden. :setformat() extrahiert aus einer font-Ressource Informationen wie Fontname und Größe und wendet die entsprechenden Formatierungen an.

  Wenn der Fontname korrekt ist, wird die Formatierung durchgeführt, unabhängig davon, ob der Font auf dem System installiert ist. Wenn der Font nicht installiert ist, wird man allerdings keine Auswirkung sehen. Man würde sie aber sehen, sobald der RTF-Text auf einem System angezeigt wird, auf dem der Font vorhanden ist.

  Angaben in der Form <size>.<font name> werden ab IDM-Version A.05.02.l unterstützt. Dabei werden Größe und Fontname ausgewertet und gesetzt.

• Vordergrundfarbe (text_fgc) und Hintergrundfarbe (text_bgc) können als integer-Wert, der als RGB-Wert interpretiert wird, oder als color-Ressource übergeben werden.

Objekte mit dieser Methode

edittext mit .options[opt_rtf] = true