Forms-Feld

<Code>$("Forms.Subject")</Code>

Field

<Code>$("Header")</Code>

Profil-Feld: Benutzer

<Code>$("Profile.User.FirstName")</Code>

Profil-Feld: Organisation

<Code>$("Profile.Org.Unit")</Code>

Text

String

FormattedText

FormattedText

WordContent

WordContent

InlineWordContent

InlineWordContent

WordTableRows

WordTableRows

Date

Date

YesNo

Boolean

Picture

Image (z. B. Profile.Org.Logo)

Object

JavaScript Objekt, welches dem Schema entspricht.

ObjectCollection

Ein JavaScript Array mit Objekten, welche dem Schema entsprechen.

$

getDateAsText(…)

String

$

joinNonEmpty(…)

String

$

formatDate(…)

String

$

formatNumber(…)

String

$

getDate(…)

Date

$

getReference(…)

FieldReference

$.formattedText

fromText(…)

FormattedText

$.formattedText

parse(…)

FormattedText

$.wordContent

fromFormattedText(…)

WordContent

$.wordContent

fromText(…)

WordContent

$.inlineWordContent

extractParagraphContentFromWordContent(…)

InlineWordContent

$.inlineWordContent

extractParagraphContentFromFormattedText(…)

InlineWordContent

$.translations

getText(…)

String

$.translations

getFormattedText(…)

FormattedText

$.snippets

getFormattedText(…)

FormattedText

$.snippets

getWordContent(…)

WordContent

$.formattedText

getBuilder(…)

FormattedText-Builder

$.wordContent

getBuilder(…)

WordContent-Builder

$.wordTableRows

getBuilder(…)

WordTableRows-Builder

$(…)

Feldtyp (je nach Id)

$

get(…)

Feldtyp (je nach Id)

$

getText(…)

String

$

getDate(…)

Date

$

getFormattedText(…)

FormattedText

$

getWordContent(…)

WordContent

$

getInlineWordContent(…)

InlineWordContent

$

getWordTableRows(…)

WordTableRows

$

getReference(…)

FieldReference

$

getYesNo(…)

YesNo

$

getObject(…)

Object

$

getObjectCollection(…)

ObjectCollection

getText(String id)

• Holt unformatierten Text via id explizit. Alternativ kann auch ein impliziter Aufruf getätigt werden (siehe Beispiel).

• Parameter id: Feld-Id. Das Feld hinter Id muss ein String ausgeben.

• Rückgabetyp: String

getDateAsText(String id)

• Holt ein Datumsfeld mittels id und konvertiert es in unformatierten Text.

• Parameter id: Feld-Id. Das Feld hinter Id muss ein Datum ausgeben.

• Rückgabetyp: String

joinNonEmpty(String separator, String item1, String item2, […])

• Fügt die in der Liste aufgeführten items vom Typ String zusammen und trennt sie anschliessend mit dem separator.

• Parameter separator: String. Zeichen, das als Separator zwischen allen Listenelementen agiert.

• Parameter item1, item2 und ff.: alle Parameter nach separator bilden eine Liste von Strings, die hinter einander ausgegeben werden.

• Rückgabetyp: String

$.joinNonEmpty(" / ", $('Profile.Org.Title'), $('Profile.Org.Unit')) Resultat: "Beispielfirma / Beispielabteilung"

Mehr Informationen hier: https://primesoft-group.atlassian.net/wiki/spaces/PD/pages/edit-v2/395444225#Funktion-joinNonEmpty()

formatDate(Date date, String format)

• Passt das Format eines Datumsobjekts date an zum gewünschten format.

• Parameter date: Datumsobjekt, entweder aus Datums-Forms-Feld, Datums-Field oder aus new Date().

• Parameter format: String. Gibt das Datumsformat an gemäss dieser Liste: Custom date and time format strings - Microsoft Learn. Im Parameter kann auch eine globale Übersetzungen geholt werden.

• Rückgabetyp: String

$.formatDate($("Forms.Date").Value, "yyyy-MM-dd")

formatNumber(String number, String format)

• Wandelt den String an zum gewünschten format.

• Parameter number: String, entweder aus Forms-Feld oder über native JavaScript Werte.

• Parameter format: String. Gibt das Nummernformat an gemäss dieser Liste: Standard numeric format strings. Im Parameter kann auch eine globale Übersetzungen geholt werden.

• Rückgabetyp: String

$.formatNumber($("Forms.Price"), "N2")

formatNumber(String number, Object options)

• Formatiert den String unter Berücksichtigung benutzerdefinierter Optionen, welche sich an die .NET Implementierung der NumberFormatInfo richtet. Die Standardkultur-Einstellungen werden übersteuert.

• Parameter number: String, entweder aus Forms-Feld oder über native JavaScript Werte.

• Parameter options: Object. Es kann NumberDecimalDigits, NumberGroupSeparator und NumberDecimalSeparator angegeben werden. Es kann auch eine globale Übersetzung geholt werden.

• Rückgabetyp: String

formatNumber(String number, String format, Object options)

• Formatiert den String zum gewünschtem format unter Berücksichtigung benutzerdefinierter Optionen, welche sich an die .NET Implementierung der NumberFormatInfo richtet. Dies kann genutzt werden z.B. den NumberGroupSeparator explizit zu übersteuern, aber trotzdem die Zahl als Währung zu formatieren.

• Parameter number: String, entweder aus Forms-Feld oder über native JavaScript Werte.

• Parameter format: String. Gibt das Nummernformat an gemäss dieser Liste: Standard numeric format strings. Im Parameter kann auch eine globale Übersetzungen geholt werden.

• Parameter options: Object. Es kann NumberDecimalDigits, NumberGroupSeparator und NumberDecimalSeparator angegeben werden. Es kann auch eine globale Übersetzung geholt werden.

• Rückgabetyp: String

formattedText.fromText(String text)

• Konvertiert einen String zu einem FormattedText.

• Parameter text: String oder Feld, das einen String zurückgibt.

• Rückgabetyp: FormattedText

Beispiel mit einem String:
$.formattedText.fromText("Ein lustiger Satz.")

Beispiel mit Referenz auf ein Feld:
$.formattedText.fromText($("Forms.Subject"))

formattedText.parse(String html, Object parameters)

• Baut aus den Argumenten einen FormattedText.

• Parameter html: String, der die HTML-Definition des FormattedText und ggf. Platzhalter im Format {{placeholderName}} enthält.

• Parameter parameters: Beschreibung aller Parameter, die als Platzhalter in html vorkommen.

• Platzhalternamen innerhalb eines FormattedText müssen eindeutig.

• Rückgabetyp: FormattedText

Beispiel ohne benannte Parameter:
$.formattedText.parse("<p data-word-style-id="Quote">Absatz in built-in 'Quote' Style</p>");

Beispiel mit benannten Parametern:
$.formattedText.parse("<p data-word-style-id="Quote">{{something}}</p>", { something: "Absatz in built-in 'Quote' Style" });

formattedText.getBuilder()

Siehe Kapitel Builder

Erstellt ein Builder-Objekt, um darauf aufbauend FormattedText oder Text mit der Funktion append() anzuhängen.

$.formattedText.getBuilder()

wordContent.fromFormattedText(FormattedText ft)

• Konvertiert einen FormattedText zu einem WordContent.