Überblick über die UI-Werkzeuge für Intent-Designs
Die UI-Werkzeuge setzen sich aus den folgenden Hauptkomponenten zusammen:
- UIPartMixin
- UICategory
- UIProperty
- UIMessage
UIPartMixin
Den Eckpfeiler der UI-Werkzeuge bildet UIPartMixin. Dieses Mixin ermöglicht die Verwaltung von Bauteilen durch die UI-Werkzeuge, und alle an UIPartMixin beteiligten Bauteile sind als UIPart-Objekte in .NET verfügbar. Das Mixin enthält die Regeln zur Verwaltung der Liste von UI-Eigenschaften eines Bauteils, seine Benutzeroberflächenaktionen und untergeordneten Komponenten sowie alle Meldungen, die an die Benutzeroberfläche gesendet werden müssen. Die absolute Mindestanforderung für das Funktionieren der UI-Werkzeuge ist, dass das Stammbauteil an UIPartMixin beteiligt sein muss.
Wichtige Regeln in UIPartMixin
- UIName
- Der in den UI-Werkzeugen durchgängig zu verwendende Anzeigename des UIPart.
- Seq
- Der beim Sortieren von UIParts verwendete Sequenzwert.
- IconPath
- Der Pfad zu dem Bild, das für dieses UIPart im UIPartTree verwendet wird.
- UIProperties
- Die Liste der UIProperties, die derzeit für dieses UIPart aktiv sind.
- UIChildren
- Die Liste der UIPart-Bauteile, die als untergeordnete Komponenten dieses UIPart im UIPartTree angezeigt werden.
- Actions
- Die Liste der UIActions, die derzeit für dieses UIPart verfügbar sind.
- Messages
- Die Liste der UIMessages, die derzeit für dieses UIPart aktiv sind.
UICategory
Das Design UICategory ist einfach ein Container für Kategorieinformationen für UIProperties. Sie dient zum Gruppieren von UIProperties sowie zum Sortieren der verschiedenen Gruppen. Außerdem enthält sie Regeln, mit denen Gruppen von UIProperties deaktiviert werden können.
Wichtige Regeln in UICategory
- CategoryName
- Der Name der Kategorie, der beim Gruppieren von UIProperties angezeigt wird.
- CategorySeq
- Der beim Sortieren von Kategorien von UIProperties zu verwendende Sequenzwert.
UIProperty
Die Konstruktion UIProperty ist der zweitwichtigste Bestandteil der UI-Werkzeuge. UIProperty dient als eigentliche Schnittstelle zwischen dem Intent-Modell und der Benutzeroberfläche. Der Vorgabewert, der aktuelle Wert, die Liste von Auswahlmöglichkeiten usw. sind alle in UIProperty gespeichert. Da das Design UIProperty eine Vielzahl von Optionen enthält, werden in diesem Dokument nur die am häufigsten verwendeten Optionen behandelt.
Wichtige Regeln in UIProperty
- CategoryPart
- Eine Referenz auf ein UICategory-Bauteil, die den Kategorienamen und die Kategoriesequenz für UIProperty angibt.
- BaseName
- Dies ist der Basisname für diese UIProperty. Er kann weiter geändert werden, indem Werte für die Parameter NamePrefix und NameSuffix angegeben werden. Allerdings ist die Verwendung von NamePrefix und NameSuffix normalerweise auf Fälle beschränkt, in denen eine Liste mit untergeordneten UIProperties verlangt wird.
- Seq
- Der beim Sortieren von UIProperties innerhalb einer Kategorie zu verwendende Sequenzwert.
- DefaultValue
- Der für die UIProperty zu verwendende Vorgabewert.
- Value
- Der aktuelle Wert der UIProperty.
- IsValueModified?
- Kennzeichnet, ob diese UIProperty durch den Benutzer über die Benutzeroberfläche geändert wurde.
- IsReadOnly?
- Legt die UIProperty als schreibgeschützt fest.
- ChoiceListValues
- Eine Liste mit Werten, aus der der Benutzer einen Wert für diese UIProperty auswählen kann.
- RestrictToList?
- Weist die UIProperty an, die Auswahl auf die in ChoiceListValues angegebenen Werte zu beschränken.
- Formatter
- Der Name oder die ID des für die UIProperty zu verwendenden Formatierers. Formatierer steuern, wie der Wert angezeigt und wie Eingabetext analysiert wird.
- Converter
- Der Name oder die ID des für die UIProperty zu verwendenden Konverters. Konverter steuern, wie der Wert im Intent-Modell gespeichert wird, da einige UI-Werte keine entsprechenden Intent-Datentypen aufweisen. Ein Beispiel für diese Art von Werten sind Datumsangaben.
- Tooltip
- Die in der Benutzeroberfläche für diese UIProperty anzuzeigende QuickInfo.
- ForPaintColor
- Die für diese UIProperty zu verwendende Vordergrundfarbe.
- BackPaintColor
- Die für diese UIProperty zu verwendende Hintergrundfarbe.
UIMessage
Die Konstruktion UIMessage dient zum Hinzufügen von Meldungen, die in der Benutzeroberfläche angezeigt werden. Dies sind in der Regel Fehler- oder Warnmeldungen, können aber auch einfach Informationen zu dem Modell sein. Alle an UIPartMixin beteiligten Designs können UIMessages enthalten.
Wichtige Regeln in UIMessage
- Severity
- Der Schweregrad der Meldung. Er kann :Info, :Warning oder :Error lauten.
- Message
- Der eigentliche Meldungstext für diese UIMessage.
- Triggered?
- Nur Meldungen, deren Parameter Triggered? als True ausgewertet wird, werden in der Benutzeroberfläche angezeigt.