Dokumentation
IPS_GetPresentationFormat
string IPS_GetPresentationFormat (string $DarstellungsID, int $Variablentyp)
Parameterliste
| DarstellungsID | Die ID der Darstellung, als GUID formatiert |
| Variablentyp | Der Variablentyp, für den das Format geliefert werden soll (0 ( |
Rückgabewert
Die Formatvorlage der Darstellung als String.
Beschreibung
Die Funktion liefert die Formatvorlage, mit der die Darstellung DarstellungsID Werte einer Variable vom Typ Variablentyp als Text darstellt, z.B. für GetValueFormatted. Die Vorlage enthält Platzhalter in geschweiften Klammern: {VALUE} für den Wert, Parameter der Darstellung wie {PREFIX} oder {SUFFIX} sowie Formatierungsanweisungen wie select, list oder ipsnumber, z.B. {VALUE, select, true{On} false{Off}}. Die Platzhalter werden nicht ersetzt – die Werte der Parameter einer Variable liefert IPS_GetVariablePresentation.
Definiert die Darstellung für den Variablentyp eine eigene Gruppe mit Format (z.B. die Wertanzeige für Boolean), wird dieses Format geliefert, ansonsten das allgemeine Format der Darstellung. Haben weder die Gruppe noch die Darstellung ein Format, wird {VALUE} geliefert. Enthält die Darstellung Übersetzungen, wird die Vorlage übersetzt, sofern eine Übersetzung vorhanden ist. Die Einschränkungen der Darstellung auf bestimmte Variablentypen werden dabei nicht geprüft.
Existiert die Darstellung nicht, schlägt die Funktion mit "Presentation with ID … not found!" fehl, bei einer ungültigen GUID mit "PresentationID … is not a valid GUID". Alle Darstellungen liefert IPS_GetPresentations, eine einzelne IPS_GetPresentation.
Beispiel
echo IPS_GetPresentationFormat('{60AE6B26-B3E2-BDB1-A3A1-BE232940664B}' /* Schalter */, VARIABLETYPE_BOOLEAN);
// liefert z.B.: {VALUE, select, true{On} false{Off}}
echo IPS_GetPresentationFormat('{3319437D-7CDE-699D-750A-3C6A3841FA75}' /* Wertanzeige */, VARIABLETYPE_BOOLEAN);
// liefert z.B.: {VALUE, list, list OPTIONS equals Value found{{Caption}} other{{VALUE}}}