2.138 .format

Dieses Attribut weist einem Objekt ein Format zu.

Beim datetime-Objekt definiert dieses Attribut das Anzeigeformat.

Beim setup-Objekt kann mit .format die Format-Variante (Nummer) erfragt werden.

Definition

  • Datentyp

    string, object [ format ]

    string, object [ text ] (datetime)

    integer (setup)

  • Zugriff

    get, set

    get, set (setup)

  • changed-Ereignis

    ja

  • C

    Bezeichner: AT_format

    Datentyp: DT_string, DT_format

    Datentyp: DT_string , DT_text (datetime)

    Datentyp: DT_integer (setup)

  • COBOL

    Bezeichner: AT-format

    Datentyp: DT-string, DT-format

    Datentyp: DT-string, Dt-text (datetime)

    Datentyp: DT-integer (setup)

  • Klassifizierung

    Textattribut

Als Format ist entweder ein String oder ein Identifikator erlaubt:

Bei Identifikator muss es eine Format-Ressource sein.

Eine Format-Ressource darf nur angegeben werden, wenn nicht schon das Attribut .formatfunc gesetzt ist (vgl. hierzu auch das Kapitel „Format-Funktionen“ im Handbuch „C-Schnittstelle - Grundlagen“).

datetime

Dieses Attribut definiert das Anzeigeformat des datetime-Objekts.

Beim Schreibzugriff (set) können Werte vom Datentyp string und text-Ressourcen angegeben werden. text-Ressourcen werden automatisch zu string gewandelt.

Lesezugriff (get) liefert immer einen Wert vom Datentyp string.

Wertebereich

""

kurzes Datumsformat (wie "widget:d")

widget:d

Systemformat: kurzes Datumsformat

widget:dd

Systemformat: kurzes Datumsformat mit 4-stelliger Jahreszahl

widget:ddd

Systemformat: langes Datumsformat

widget:t

Systemformat: Zeitformat

<format_string>

Formatstring zur Definition des Anzeigeformats

Systemformate

Die Systemformate sind abhängig von den Sprach- und Regionseinstellungen des Betriebssystems. Sie bestimmen das Anzeigeformat jeweils vollständig und sind weder miteinander noch mit Formatstrings kombinierbar. Es kann zum Beispiel keine Beschriftung zu einem Systemformat hinzugefügt werden.

Formatstrings

Formatstrings bestehen aus Formatierungszeichen, die definieren, welche Teile eines Datums angezeigt werden und wie diese Teile angezeigt werden.

Tabelle 1-2: Formatierungszeichen des datetime-Objekts

Formatierungszeichen

Anzeige

d

Tag mit so vielen Stellen wie notwendig

dd

Tag mit 2 Stellen, gegebenenfalls mit führender 0

ddd

Name des Wochentags (sprachabhängig), abgekürzt auf 3 Zeichen

dddd

vollständiger Name des Wochentags (sprachabhängig)

h

Stunde im 12-Stundenformat mit so vielen Stellen wie notwendig

hh

Stunde im 12-Stundenformat mit 2 Stellen, gegebenenfalls mit führender 0

H

Stunde im 24-Stundenformat mit so vielen Stellen wie notwendig

HH

Stunde im 24-Stundenformat mit 2 Stellen, gegebenenfalls mit führender 0

m

Minute mit so vielen Stellen wie notwendig

mm

Minute mit 2 Stellen, gegebenenfalls mit führender 0

M

Monat mit so vielen Stellen wie notwendig

MM

Monat mit 2 Stellen, gegebenenfalls mit führender 0

MMM

Monatsname (sprachabhängig), abgekürzt auf 3 Zeichen

MMMM

vollständiger Monatsname (sprachabhängig)

s

Sekunde mit so vielen Stellen wie notwendig

ss

Sekunde mit 2 Stellen, gegebenenfalls mit führender 0

t

Vormittags- bzw. Nachmittagskennzeichen (sprachabhängig, im Englischen AM und PM) mit einem Zeichen; Verwendung wird nicht empfohlen

tt

Vormittags- bzw. Nachmittagskennzeichen (sprachabhängig, im Englischen AM und PM) mit 2 Zeichen

yy

Jahr mit 2 Stellen

yyyy

Jahr mit 4 Stellen

Andere Zeichen als die genannten Formatierungszeichen werden in die Anzeige übernommen. Zeichen, die angezeigt werden sollen, können optional in einfache Anführungszeichen (') eingeschlossen werden. Sie müssen in einfache Anführungszeichen eingeschlossen werden, wenn sie einem Formatierungszeichen entsprechen. Um ein einfaches Anführungszeichen anzuzeigen, muss es im Formatstring verdoppelt werden ('').

Beispiel

Der Formatstring 'Heute ist 'dddd', der 'dd'. 'MMM yyyy ergibt folgende Anzeige: Heute ist Freitag, der 04. Jul 2014.

Hinweise

  • Bei einem fehlerhaften Formatstring wird das systemabhängige Standardformat verwendet (entspricht .format = "").
  • Die für ddd, dddd, MMM, MMMM, t und tt angezeigten Namen und Kennzeichen werden durch die Sprach- und Regionseinstellungen des Systems bestimmt.
  • Bei langen Anzeigetexten kann es sein, dass auf der Schaltfläche zum Öffnen des Kalenders kein Kalendersymbol mehr dargestellt wird.

setup

Mit .format kann beim Setup-Objekt die Format-Variante (Nummer) erfragt werden.

Hinweis zur Abfrage des Attributs .format mit DM_GetVectorValue

Es ist zu beachten, dass DM_GetVectorValue() bei der Abfrage von .format die Formatdefinition nur bei Verwendung von Format-Ressourcen zurückliefern kann. Bei Formatdefinitionen per Formatstring oder Formatfunktion wird Null zurückgeliefert. Daher wird die Nutzung von Formatressourcen empfohlen.

Mit den Optionen DMF_GetMasterString und DMF_GetLocalString erhält man einen Formatstring wie bei einer Formatdefinition per Formatstring.

Damit entsprechen die zurück gelieferten Werte der Funktion DM_GetVectorValue denen der Funktion DM_GetValueIndex bzw. eines getvalue in der Regelsprache.