Widget.ts
Ist die Basis für die Widget Funktionalitäten im Client und bietet die Möglichkeit an, manche davon anzupassen.
SetWidgetState
Widgets haben einen Status, der „NotLoaded“, „Loading“, „Loaded“, „Blocked”, “Error”, “ContentBlocked” und “ContentError” sein kann. Was für einen Status ein Widget hat, hängt von dem Laden des Widgets ab und wird automatisch gesetzt. Die Funktion SetWidgetState kann aufgerufen werden, um unter Umstände den Status vom Widget zu ändern. Zum Beispiel bei Fehlern.
ReadSourceParameterJsonString
Wenn das Widget einen Parameter braucht, liefert diese Funktion den Parameter in einer JSON formatierte String aus der Quelle zurück.
GetProvidedParameterJsonString
Wenn das Widget einen Parameter bereitstellt, wird diese Funktion den Parameter in einer JSON formatierte String aus der Quelle zurückliefern.
GetProvidedParameter
Wenn das Widget einen Parameter von Typ T bereitstellt, wird diese Funktion das entsprechende Objekt zurückliefern.
SetProvidedParameter
Wenn das Widget einen Parameter von Typ T bereitstellt, wird diese Funktion das als Funktionparameter gegebene Objekt als Parameter vom Widget setzen und ein entsprechende UI Event triggern, damit andere Widgets sich aktualisieren können, um die neuen Daten zu nutzen.
OnParameterChanged
Funktion die aufgerufen wird, wenn das Parameter, das das Widget nutzt, aktualisiert worden ist.
AddWidgetAction
Fügt eine Aktion in der Widget UI hinzu. Die Aktionen werden oben rechts angezeigt, wenn ein Benutzer den Maus über das Widget zieht. Basis Aktionen und überschreibare Funktionalität sind:
Refresh
Läd das Widget neu.
Collapse
Verstecken oder anzeigen des Widgets. Bei einem Widget mit verstecktem Inhalt, wird nur der Titel und die Aktionen angezeigt. Für diese Aktion sind folgende Funktionen überschreibar: BeforeCollapsing / BeforeExpanding, um Code direkt vor der Collapse/Expand Aktion zu ausführen, beziehungsweise false zurückliefern, um die Aktion zu abbrechen; und OnCollapsed / OnExpanded, um Code direkt nach der Collapse/Expand Aktion zu führen.
Maximize
Zeigt das Widget vergrößert (volle Seite) an, oder in der originalen Große. Für diese Aktion sind folgende Funktionen überschreibar: OnMaximized / OnSizeRestore, um Code direkt nach der Maximize/Restore Aktion zu führen.
Vorgabe-Focus
Handelt das Setzen des Focus im Widget, wenn das Widget den Vorgabe-Focus in der Seite erhält.
GetUISetting
Liest Benutzerspezifische UI Widget Einstellungen.
SetUISetting
Speichert Benutzerspezifische UI Widget Einstellungen.
Init
Bietet die Möglichkeit an, Code auszuführen als das Widget im Browser initialisiert wird. In diesem Zeitpunkt könnte der Inhalt des Widgets noch nicht gerendert sein.
OnContentLoaded
Bietet die Möglichkeit an, Code auszuführen als der Inhalt des Widgets im Browser geladen ist.
Parameters
Die Parameter Klassen in Typescript entsprechen die .cs Klassen.