FormatString

function FormatString(formatString: string, ...args: any[]): string | null

Die Funktion FormatString formatiert einen gegebenen String, indem für Platzhalter in dem String die Werte der Symbole eingesetzt werden.

Parameter

Name

Typ

Beschreibung

formatString

string

Ein String mit Platzhaltern.

…args [ Rest Parameter ]

any[]

Beliebiger Wert, der in einen Platzhalter eingesetzt wird.

Rückgabewert

Typ

Beschreibung

string | null

String, in dem die Platzhalter durch Werte der Symbole ersetzt werden oder null wenn etwas anderes als String als formatString übergeben wurde.

Platzhalter

Beispiel: {0|.1f}

Platzhalter

Beschreibung

{

Platzhalter wird eingeleitet.

0

Index des Parameters (optional, ohne Index wird der Reihe nach iteriert).

|

Separator.

+

Wird hier ein + angegeben, so erhält der String in jedem Fall ein Vorzeichen. Also beispielsweise "+42" für die positive Zahl 42. Negative Zahlen erhalten natürlich immer ein Vorzeichen.

.X

Anzahl der Stellen.

f

Typenbeschreibung.

}

Ende des Platzhalters.

Typenbeschreibung

Character

Beschreibung

d

Signed decimal integer

i

Signed decimal integer

u

Unsigned decimal integer

o

Unsigned octal

x

Unsigned hexadecimal integer

X

Unsigned hexadecimal integer (uppercase)

f

Decimal floating point

e

Scientific notation (mantissa/exponent), lowercase

g

Use the shortest representation: e or f

s

String of characters

b

Binary number

t

true or false

T

Type of the argument ('number', 'string', 'null' …)

v

Primitive value of the specified argument

j

JavaScript object or array as a JSON encoded string

NuGet Paket: Beckhoff.TwinCAT.HMI.Functions

FormatString 1:

NuGet-Pakete sind verfügbar ab Version 1.12.

FormatString 2:

Verfügbar ab Version 1.10

Beispiel

Input:

FormatString('Hello {1|.5s}. This is a floating point number - {0|.2f}. Two zeros are attached - {03i} (3 digits in total).', 2, 'World123', 3);

Output:

"Hello World. This is a floating point number – 2.00. Two zeros are attached – 003 (3 digits in total)."