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

Date

Date

YesNo

Boolean

Picture

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

$

getDateAsText()

String

$

joinNonEmpty()

String

$

formatDate()

String

$

getDate()

Date

$.formattedText

fromText()

FormattedText

$.formattedText

parse()

FormattedText

$.wordContent

fromFormattedText()

WordContent

$.wordContent

fromText()

WordContent

$.translations

getText()

String

$.translations

getFormattedText()

FormattedText

$.snippets

getFormattedText()

FormattedText

$.snippets

getWordContent()

WordContent

$.formattedText

getBuilder()

FormattedText-Builder

$.wordContent

getBuilder()

WordContent-Builder

$()

Feldtyp (je nach Id)

$

get()

Feldtyp (je nach Id)

$

getText()

String

$

getDate()

Date

$

getFormattedText()

FormattedText

$

getWordContent()

WordContent

$

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

<Text Name="FirstName2"><!-- explizit -->
  <Code>$.getText('Profile.User.FirstName')</Code>
</Text>

<Text Name="FirstName1"><!-- implizit -->
  <Code>$('Profile.User.FirstName')</Code>
</Text>

getDateAsStringgetDateAsText(String id)

• Holt ein Datumsfeld mittels id und konvertiert es in einen String (= unformatierten Text).

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

• Rückgabetyp: String

<Text Name="Date">
  <Code>$.getDateAsStringgetDateAsText("Forms.Date")</Code>
</Text>

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: XXX

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")

formattedText.fromText(String text)

• Konvertiert einen String zu einem FormattedText.

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

• Rückgabetyp: String

Beispiel mit einem String:
$.formattedText.getBuilder()

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.

• Parameter

• ft: Parametertyp:

• FormattedText, zwingend

• .

• Rückgabetyp:

• WordContent

Beispiel mit FormattedText aus Übersetzung:

$.wordContent.fromFormattedText($.translations.

getFormattedText("

FormattedTexts.

CopyTo")

)

Beispiel mit FormattedText aus Textbaustein:

$.wordContent.fromFormattedText($.snippets.getFormattedText("Introduction"))

Beispiel mit Referenz auf Feld:

$.wordContent.fromFormattedText($("IntroductionFT"))

wordContent.fromText(String text)

• Konvertiert einen Text zu einem WordContent.

• Parameter text: Parametertyp: String, zwingend

• .

• Rückgabetyp: WordContent

Beispiel mit einem String:

$.wordContent.fromText("Ein lustiger Satz.")

Beispiel mit

Referenz auf ein Feld:

$.

wordContent.

fromText($("Forms.Subject")

)

wordContent.getBuilder()

Siehe Kapitel Builder

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

$.wordContent.getBuilder()

translations.getText(String id)

• Holt eine unformatierte Übersetzung aus den globalen Übersetzungen.

• Parameter id: Parametertyp: String, zwingend, Angabe der Id des Übersetzungseintrags in den Globalen Übersetzungen

• Rückgabetyp: String

$.translations.getText("Texts.Subject")

translations.getFormattedText(String id, Object parameters)

Holt eine formatierte Übersetzung aus den globalen Übersetzungen.

• Parameter id: Parametertyp: String, zwingend, Angabe der Id des Übersetzungseintrags in den Globalen Übersetzungen

• Parameter parameters: Parametertyp: Object, falls die Übersetzung über Parameter verfügt, zwingend:
  Liste von Key-Value-Pairs mit Values gemäss Übersetzung (Typen in Handlebars: Strings, Arrays oder Booleans).

• Rückgabetyp: FormattedText

Beispiel ohne parameters:

$.translations.getFormattedText("ContractTitle")

Beispiel mit parameters:

$.translations.getFormattedText("FormattedTexts.Paragraphs.BoldNormal", { bold: $("Forms.Subject"), normal: "Untertitel-Text" } )

snippets.getWordContent(String key, Object placeholders)

• Holt ein WordContent-Textbaustein mit einem bestimmten Schüssel.

• Parameter key: obligatorisch, Parametertyp: String, Angabe des Textbaustein-Schlüssels

• Parameter placeholders: Parametertyp: Object, es SnippetPlaceholder gibt, zwingend,
  Liste von Key-Value-Pairs mit String-Values

• Rückgabetyp: WordContent

Beispiel ohne placeholders:

$.snippets.getWordContent("Introduction")

Beispiel mit placeholders:

$.snippets.getWordContent("Introduction", { dateToday: $.getDateAsText("Forms.Date"), guests: $("Guests") } )

snippets.getFormattedText(String key)

• Holt einen formatierten Text als Textbaustein mit einem bestimmten Schüssel.

• Parameter key: Parametertyp: String, obligatorisch, Angabe des Textbaustein-Schlüssels

• Rückgabetyp: FormattedText

$.snippets.getFormattedText("FooterFTSnippet")

formattedText.getBuilder()

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

• Parameter: keine

• Rückgabetyp: FormattedText-Builder-Objekt

• Aufruf in einem FormattedText-Field: $.formattedText.getBuilder()

wordContent.getBuilder()

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

• Parameter: keine

• Rückgabetyp: WordContent-Builder-Objekt

• Aufruf in einem WordContent-Field: $.wordContent.getBuilder()

append(WordContent/FormattedText content)

• Hängt den Inhalt von Parameter content in die Builder-Pipeline.

• Parameter content: zwingend, Parametertyp WordContent oder FormattedText, je nach dem in was für einem Field-Typen man sicht befindet.

• Rückgabetyp: WordContent oder FormattedText

• Aufruf auf dem Builder-Objekt bspw. in einem WordContent-Field:

builder
.append($.snippets.getWordContent("Introduction"))

.append($.wordContent.

fromText("

- mit Builder"))

Siehe ausführliches Beispiel weiter unten.

build()

• Letzter zwingender Funktionsaufruf in einer Reihe von Builder-Funktionen. Löst die Build-Pipeline aus und baut sich dann alle “appended” Teile von links nach rechts zusammen.

• Parameter: keine

• Rückgabetyp: FormattedText/WordContent

• Aufruf auf dem Builder-Objekt: builder.build()

$(String name) / $.get(String name)

• Holt ein Feld gemäss Argument.

• Parameter name: Parametertyp: String, obligatorisch, Angabe des Feldnamens

• Rückgabetyp: dem geholten Feld entsprechend

• siehe auch https://primesoft-group.atlassian.net/wiki/spaces/PDT/pages/edit-v2/398131214#Zugriff-auf-Felder

$("Profile.User.FirstName") / $.get("Forms.Date")

$.getText(String name)

• Holt einen Text.

• Parameter name: Parametertyp: String, obligatorisch, Angabe des Feldnamens

• Rückgabetyp: Text

$.getText("Forms.Subject")

$.getDate(String name)

• Holt ein Date.

• Parameter name: Parametertyp: String, obligatorisch, Angabe des Feldnamens

• Rückgabetyp: Text

$.getDate("DateWrittenOut")

$.getFormattedText(String name)

• Holt einen FormattedText.

• Parameter name: Parametertyp: String, obligatorisch, Angabe des Feldnamens

• Rückgabetyp: FormattedText

$.getFormattedText("Forms.Subject")

$.getWordContent(String name)

• Holt ein WordContent.

• Parameter name: Parametertyp: String, obligatorisch, Angabe des Feldnamens

• Rückgabetyp: WordContent

$.getWordContentText("Forms.Subject")

$.getYesNo(String name)

• Holt ein YesNo.

• Parameter name: Parametertyp: String, obligatorisch, Angabe des Feldnamens

• Rückgabetyp: YesNo

$.getYesNo("Confidentiality")

$.getObject(String name)

• Holt ein Object.

• Parameter name: Parametertyp: String, obligatorisch, Angabe des Namens eines Feldes

• Rückgabetyp: Object

$.getObject("SingleRecipient")

$.getObjectCollection(String name)

• Holt eine ObjectCollection.

• Parameter name: Parametertyp: String, obligatorisch, Angabe des Feldnamens

• Rückgabetyp: ObjectCollection

$.getObjectCollection("Participants")