Business App Leitfaden für Anpassungen

13.7.5. Einstellung durch den Anwender

In der Widget Klasse

Widget Settings ermöglichen das ändern von Einstellungen durch den Anwender.

WidgetSettingsAttribute

Beim WidgetSettingsAttribute handelt es sich im ein Attribut mit welchem Eigenschaften innerhalb eines Widgets als Widget-Setting gekennzeichnet werden können. Ihr erscheinen innerhalb des Dialogs, kann mithilfe eines Parameters oder einer Funktion gesteuert werden. 

[WidgetSettings(nameof(Example), WidgetUIScope.WidgetOnPage, true)]
public virtual bool Example { get; set; }
[WidgetSettings(“Example“, WidgetUIScope.WidgetInTab, SkipRenderMethod = nameof(SkipRenderOfWidgetSettings))]
public virtual bool Example { get; set; }

Das WidgetSettingsAttribut verfügt über folgende Eigenschaften:

  • UISettingName Der Name unter dem die Einstellung gespeichert wird
  • Scope Das WidgetUIScope auf das sich die Einstellung bezieht
  • SkipRender Indikator, ob die Einstellung im Dialog angezeigt werden soll oder nicht (optional)
  • SkipRenderMethod Methode um die Anzeige im Dialog dynamisch zu steuern

Hilfsmethoden

In der Klasse WidgetBase finden sich diverse Methoden zur Interaktion mit den Settings.

ShowWidgetSettingsWidgetAction

Überschreibbare Methode zur Kontrolle der Anzeige der WidgetSettingsDialog-Option für den Anwender 

GetWidgetSettingOrConfigVal

Methode um den für die aktuellen Wert zu erhalten. Diese Methode schaut zuerst, ob ein gültiger Wert des Anwenders vorliegt, falls nicht wird der konfigurierte Wert zurückgegeben. Diese Methode sollte immer dann genutzt werden, wenn der Wert der Eigenschaft verwendet wird.

GetWidgetSetting

Überschreibbare Methode um benutzerspezifische Widgeteinstellungen zu lesen.

bs. RemoveWidgetSetting

Überschreibbare Methode zum Löschen von Settings für den aktuellen Benutzer innerhalb des aktuellen Widgets. 

RemoveWidgetSettingsForWidgetProperties

Überschreibbare Methode zum Entfernen aller Settings des aktuellen Benutzers für alle mit dem WidgetSettingsAttribut gekennzeichneten Eigenschaften des aktuellen Widgets. 

SetWidgetSetting

Überschreibbare Methode zum Speichern benutzerspezifischer Widgeteinstellungen.

TypeScript

Auch in Typescript stehen Funktionen zum Umgang mit den Settings zur Verfügung.

Widget

GetWidgetSetting

Funktion zum Lesen eines benutzerspezifischen Settings 

SetWidgetSetting

Funktion zum Speichern eines benutzerspezifischen Settings 

RemoveWidgetSetting

Funktion zum Entfernen eines benutzerspezifischen Settings

WidgetSettingsUtils

Auch in Typescript steht eine Klasse mit Hilfsfunktionen zur Verfügung. Diese Verfügt über folgende Methoden

SetWidgetSetting

Ermöglicht das Speichern eines Settings.

GetWidgetSetting

Ermöglicht das Lesen eines Settings. 

RemoveWidgetSetting

Ermöglicht das Entfernen eines Settings. 

SetDefaultWidgetSettings

Speichert alle Default-Settings für ein Widget und einen Benutzer.

RemoveAllWidgetSettings

Setzt alle Settings für ein Widget und einen Benutzer auf die Defaulteinstellungen zurück.