Enums and value types
Every enum and every value type a component property or an item model carries, with what each member means. A property page links here from its type.
Value types
A length, a colour, a text appearance: built from a static member, or written as its parts.
ColorVariant
| Member | Meaning |
|---|---|
FromRgb(byte red, byte green, byte blue, ColorAdjustment adjustment = ColorAdjustment.None, int factor = 0, byte opacity = 255) | |
FromColor(Color color, ColorAdjustment adjustment = ColorAdjustment.None, int factor = 0) | |
TryParseHex(string? text, ColorVariant variant) | |
Nearest(Color color) | |
Nearest(byte red, byte green, byte blue, byte opacity = 255) | |
MinFactor | |
MaxFactor | |
ColorName Name | |
ColorAdjustment Adjustment | |
int Factor | |
byte Opacity | |
int? Rgb |
UIActionArgument
Represents a value, binding, or contextual value passed to a UI action.
| Member | Meaning |
|---|---|
Literal(object? value) | Creates a literal action argument from a value. |
Literals(params KeyValuePair<string, object>[] arguments) | Creates literal action arguments from named values, keeping their names and order. |
CurrentItem() | Creates an action argument resolved from the current item. |
CurrentItemKey() | Creates an action argument resolved from the current item key. |
GroupKey() | Creates an action argument resolved from the current item's group. |
EventKey(int index) | Creates an action argument resolved from the key at index of the event's own key chain. |
EventValue() | Creates an action argument resolved from what the event carries after the keys that address its component. |
EventValue(int index) | Creates an action argument resolved from the value at index of what the event carries after the keys that address its component. |
Bind(UIBindingPath binding) | Creates an action argument resolved from a binding path. |
UIActionArgumentKind Kind | How this argument is resolved. |
object Value | The literal value for literal arguments, the place in the event's key chain for an event key, or the tuple index for an event value. |
UIBindingPath? Binding | The binding path for binding arguments. |
bool Offered | Whether the framework offers the argument beside the author's own (a drop, an edited row's key): a command with no parameter for it leaves it untaken, and the compile does not warn of it. |
UIBindingPath
Represents a recursive binding path and the context used to resolve it.
| Member | Meaning |
|---|---|
Relative(RecursivePath path) | Creates a binding path resolved relative to the current binding context. |
Parent(RecursivePath path) | Creates a binding path resolved in the scope around the component's own (UIBindingScope.Parent). |
Root(RecursivePath path) | Creates a binding path resolved relative to the root binding context. |
RecursivePath Path | The recursive binding path. |
UIBindingScope Scope | The context used to resolve the path. |
UICornerRadius
Corner radius values, in pixels, for a rectangular UI element's four corners.
| Member | Meaning |
|---|---|
All(double topLeft, double topRight, double bottomRight, double bottomLeft) | Creates a corner radius with an independent value for each corner. |
Uniform(double radius) | Creates a corner radius applying the same value to all four corners. |
Top(double radius) | Creates a corner radius rounding only the top corners, leaving the bottom corners square. |
Bottom(double radius) | Creates a corner radius rounding only the bottom corners, leaving the top corners square. |
double TopLeft | |
double TopRight | |
double BottomRight | |
double BottomLeft |
UIGridPlacement
A component's placement in the fixed-column grid: 1-based column/row, and how many columns/rows it spans.
| Member | Meaning |
|---|---|
At(int column, int row, int columnSpan = 1, int rowSpan = 1) | Creates a placement at the given column and row with the given spans. |
GridColumns | Gets the number of columns in the standard UI grid. |
int Column | |
int Row | |
int ColumnSpan | |
int RowSpan |
UILayoutLength
Represents a layout length value.
| Member | Meaning |
|---|---|
Auto() | Creates a layout length that sizes automatically to its content. |
Absolute(double value) | Creates a layout length with a fixed absolute value. |
Fill() | The whole of what the parent gives, less the component's own margin on that axis: a list with SetMargin(8) and a Fill height fits its parent with 8 px clear at either end rather than overflowing it by the margin. |
UILayoutLengthKind Kind | Whether the length is absolute, the whole of what the parent gives, or the content's own. |
double Value | The length in pixels for UILayoutLengthKind.Absolute; -1 for the kinds that carry none. |
UIProperty
Represents a UI component property key.
| Member | Meaning |
|---|---|
string Name | The property name. |
UITextAppearance
Represents a text's typography: either a semantic UITextType role, or an explicit UITextAppearance.Size override.
UITextAppearance.Weight, UITextAppearance.LineHeight and UITextAppearance.LetterSpacing are read only alongside an explicit UITextAppearance.Size.
| Member | Meaning |
|---|---|
FromRole(UITextType role) | Creates a text appearance tracking the given semantic UITextType role live. |
Custom(double size, int? weight = null, double? lineHeight = null, double? letterSpacing = null) | Creates a text appearance from an explicit font size, optionally overriding weight, line-height, and letter-spacing. |
Display | The largest, most prominent typographic role, for hero-style text, tracked live via UITextAppearance.FromRole. |
Title | The typographic role for primary headings, tracked live via UITextAppearance.FromRole. |
Subtitle | The typographic role for secondary headings, tracked live via UITextAppearance.FromRole. |
Body | The typographic role for regular body text, tracked live via UITextAppearance.FromRole. |
Caption | The typographic role for small, supplementary text, tracked live via UITextAppearance.FromRole. |
Overline | The typographic role for small label text placed above content, tracked live via UITextAppearance.FromRole. |
UITextType? Role | The semantic role sizing the text; used only while Size is unset. |
double? Size | An explicit size, in pixels, which wins over the role. |
int? Weight | An explicit font weight. |
double? LineHeight | An explicit line height, in pixels. |
double? LetterSpacing | An explicit letter spacing, in pixels. |
UIThemeColor
Represents a themed color: either a semantic UIColorStyle role, or an explicit UIThemeColor.Light/UIThemeColor.Dark override, which wins when set.
| Member | Meaning |
|---|---|
FromStyle(UIColorStyle style) | Creates a theme color tracking the given semantic UIColorStyle role live. |
FromColorVariant(ColorName name, ColorAdjustment adjustment = ColorAdjustment.None, int factor = 0, byte opacity = 255) | Creates a theme color from a fixed color variant, used identically in both light and dark mode. |
FromColorVariant(ColorVariant color) | Creates a theme color from a fixed color variant, used identically in both light and dark mode. |
Create(ColorVariant? light, ColorVariant? dark) | Creates a theme color from explicit light and dark overrides. |
TryParse(string? text, UIThemeColor color) | Reads the canonical wire form a client sends back: @Role for a semantic role, #RRGGBBAA for an explicit colour, or Name/Adjustment/factor/opacity for a palette variant. |
Default | Presets mirroring each UIColorStyle role, theme-aware via UIThemeColor.FromStyle. |
Primary | The theme's primary brand color, tracked live via UIThemeColor.FromStyle. |
Accent | The theme's secondary accent color, tracked live via UIThemeColor.FromStyle. |
Background | The page/surface background color, tracked live via UIThemeColor.FromStyle. |
Surface | A raised surface's background color (e.g. a card), tracked live via UIThemeColor.FromStyle. |
OnPrimary | A color intended to sit on top of UIThemeColor.Primary, tracked live via UIThemeColor.FromStyle. |
OnAccent | A color intended to sit on top of UIThemeColor.Accent, tracked live via UIThemeColor.FromStyle. |
OnBackground | A color intended to sit on top of UIThemeColor.Background, tracked live via UIThemeColor.FromStyle. |
OnSurface | A color intended to sit on top of UIThemeColor.Surface, tracked live via UIThemeColor.FromStyle. |
Info | The informational status color, tracked live via UIThemeColor.FromStyle. |
Warning | The warning status color, tracked live via UIThemeColor.FromStyle. |
Success | The success status color, tracked live via UIThemeColor.FromStyle. |
Danger | The danger/error status color, tracked live via UIThemeColor.FromStyle. |
OnInfo | A color intended to sit on top of UIThemeColor.Info, tracked live via UIThemeColor.FromStyle. |
OnWarning | A color intended to sit on top of UIThemeColor.Warning, tracked live via UIThemeColor.FromStyle. |
OnSuccess | A color intended to sit on top of UIThemeColor.Success, tracked live via UIThemeColor.FromStyle. |
OnDanger | A color intended to sit on top of UIThemeColor.Danger, tracked live via UIThemeColor.FromStyle. |
Muted | A dimmed variant of the ambient color, for secondary/de-emphasized text, tracked live via UIThemeColor.FromStyle. |
Selected | The chrome token indicating a selected item or state, tracked live via UIThemeColor.FromStyle. |
FocusRing | The focus indicator ring color, tracked live via UIThemeColor.FromStyle. |
Border | The default border color, tracked live via UIThemeColor.FromStyle. |
Mark | The edge that says a control is there, reading 3:1 on its ground, tracked live via UIThemeColor.FromStyle. |
Shadow | The drop shadow color, tracked live via UIThemeColor.FromStyle. |
Overlay | The modal/scrim overlay color, tracked live via UIThemeColor.FromStyle. |
Transparent | No fill: a colour of no opacity, the same in both themes. A background written it shows what is behind it, and what stands on it takes the page's ink, as on the page's own grounds. |
UIColorStyle? Style | The semantic role the palette resolves the colour from. |
ColorVariant? Light | An explicit colour for the light theme. |
ColorVariant? Dark | An explicit colour for the dark theme. |
UIThickness
Thickness values, in pixels, for a rectangular UI element's four sides.
| Member | Meaning |
|---|---|
All(double left, double top, double right, double bottom) | Creates a thickness with an independent value for each side. |
Uniform(double value) | Creates a thickness applying the same value to all four sides. |
Symmetric(double horizontal, double vertical) | Creates a thickness applying one value to the left/right sides and another to the top/bottom sides. |
double Left | |
double Top | |
double Right | |
double Bottom |
UIValidationMessage
A validation message a controller puts on an input: the severity and the words. Null on the property means none.
The words are translatable as a label is: a text is looked up as a plain value on a translatable property is — under key prefixes only a prefixed one — and a UIPhrase always; the page shows them in its language and again after a switch.
| Member | Meaning |
|---|---|
Error(string message) | A message that refuses the value. |
Error(UIPhrase message) | A message that refuses the value. |
Warning(string message) | A message that warns about the value without refusing it. |
Warning(UIPhrase message) | A message that warns about the value without refusing it. |
Info(string message) | A message that only tells the viewer something about the value. |
Info(UIPhrase message) | A message that only tells the viewer something about the value. |
UIValidationSeverity Severity | How the message is drawn and whether it refuses a submit. |
UIPhrase Message | The words shown under the input, or in its marker's tooltip: the author's text (UIPhrase.IsText) or a phrase. |
Enums
ColorAdjustment
| Member | Meaning |
|---|---|
None | |
Shade | |
Tint |
ColorName
| Member | Meaning |
|---|---|
IronFog | |
SilverNight | |
BronzeDusk | |
StellarRed | |
NebulaRose | |
LunarPink | |
PulsarMagenta | |
SolarAmber | |
NebulaLemon | |
LunarYellow | |
SolarGold | |
EclipseOlive | |
NebulaLime | |
LunarSage | |
AuroraGreen | |
NebulaMint | |
LunarFern | |
AstralTeal | |
NebulaCyan | |
LunarMoss | |
QuantumBlue | |
NebulaAqua | |
LunarAzure | |
NovaPurple | |
NebulaViolet | |
LunarLavender | |
Comet | |
Flare | |
Ember | |
Photon | |
Vortex | |
Halo |
UIActionArgumentKind
Defines how an interaction action argument is resolved.
| Member | Meaning |
|---|---|
Literal | The argument value is a fixed literal. |
CurrentItem | The argument value is the current item of the enclosing items scope. |
CurrentItemKey | The argument value is the key of the current item of the enclosing items scope. |
Binding | The argument value is resolved from a binding. |
EventKey | The argument value is one key of the event's own chain, by its place in it — for an event that names its keys itself. |
EventValue | The argument value is what the event carries after the keys that address its component — the place a dragged row was dropped at. |
GroupKey | The argument value is the group of the current item — in a group header, the group the header heads. |
UIActionBarAlignment
How a component's action bar lines up with it (SetActionBar): the bar floats above the component, under it where there is no room above, aligned with its end, its start or its middle. Start and end follow the page's direction, so a right-to-left page mirrors them.
| Member | Meaning |
|---|---|
End | Aligned with the end edge, where a messenger puts a message's actions. |
Start | Aligned with the start edge. |
Center | Centred on the component, as over a node on a canvas. |
UIAlignment
Defines cross-axis or main-axis alignment for UI layout.
| Member | Meaning |
|---|---|
Start | Aligns content to the start of the axis. |
Center | Aligns content to the center of the axis. |
End | Aligns content to the end of the axis. |
Stretch | Stretches content to fill the axis. |
UIBadgeFill
Defines how a badge spends its colour: on its ground, on a light tint of it, or on its edge alone.
| Member | Meaning |
|---|---|
Filled | The colour as the ground, with the words in the colour that reads on it. |
Tinted | A light tint of the colour as the ground, with the words in the colour's ink. |
Outline | No ground, a thin edge in the colour, and the words in the colour's ink. |
UIBadgeVariant
Defines visual variants for badge-like components.
| Member | Meaning |
|---|---|
Primary | The theme's primary brand color variant. |
Accent | The theme's secondary accent color variant. |
Info | The informational status color variant. |
Warning | The warning status color variant. |
Success | The success status color variant. |
Danger | The danger/error status color variant. |
Surface | A card-like distinct background variant with no color accent. |
Plain | The content alone, with no ground, edge or padding, in the muted ink; a reachable one brightens under the pointer and the keyboard. |
UIBindingMode
Defines how data flows between a binding source and a UI target.
| Member | Meaning |
|---|---|
OneWay | Updates flow only from the binding source to the UI target. |
TwoWay | Updates flow in both directions between the binding source and the UI target. |
OneWayToSource | Updates flow only from the UI target to the binding source. |
OnSubmit | Target-to-source updates are buffered until an explicit submit occurs. |
UIBindingScope
Defines the component context used to resolve a binding path.
| Member | Meaning |
|---|---|
Relative | Resolves the binding path relative to the component's own context. |
Parent | Resolves the binding path in the scope around the component's own: up past the nearest component that defines a context (a row's template, a menu's entry), one step out — so a control straight in a row reaches the list's scope, not the row. |
Root | Resolves the binding path relative to the root context. |
UIColorStyle
Defines semantic color roles used by UI components.
| Member | Meaning |
|---|---|
Default | No explicit color override; inherits the ambient color. |
Primary | The theme's primary brand color. |
Accent | The theme's secondary accent color. |
Background | The page/surface background color. |
Surface | A raised surface's background color (e.g. a card). |
OnPrimary | A color intended to sit on top of UIColorStyle.Primary. |
OnAccent | A color intended to sit on top of UIColorStyle.Accent. |
OnBackground | A color intended to sit on top of UIColorStyle.Background. |
OnSurface | A color intended to sit on top of UIColorStyle.Surface. |
Info | The informational status color. |
Warning | The warning status color. |
Success | The success status color. |
Danger | The danger/error status color. |
OnInfo | A color intended to sit on top of UIColorStyle.Info. |
OnWarning | A color intended to sit on top of UIColorStyle.Warning. |
OnSuccess | A color intended to sit on top of UIColorStyle.Success. |
OnDanger | A color intended to sit on top of UIColorStyle.Danger. |
Muted | A dimmed variant of the ambient color, for secondary/de-emphasized text. |
Selected | The color indicating a selected item or state. |
FocusRing | The color of the focus indicator ring around focused elements. |
Border | The default border color. |
Shadow | The color used for drop shadows. |
Overlay | The color used for modal/scrim overlay backgrounds. |
Mark | The edge that says a control is there (a field's border, an unchecked box's ring), reading 3:1 on its ground. |
UIComparisonOperator
Defines comparison operators used by UI validation and interaction rules.
| Member | Meaning |
|---|---|
Required | The value must be present: not null, not false, and not empty or whitespace text. |
Equal | The value must equal the comparison value. |
NotEqual | The value must not equal the comparison value. |
Greater | The value must be greater than the comparison value. |
GreaterOrEqual | The value must be greater than or equal to the comparison value. |
Less | The value must be less than the comparison value. |
LessOrEqual | The value must be less than or equal to the comparison value. |
Like | The value must contain the comparison value as a substring. |
In | The value (or at least one element when the value is a collection) must be contained in the comparison value's collection. |
Regex | The value must match the comparison value as a regular expression. |
LikeIgnoreCase | The value must contain the comparison value as a substring, ignoring case. |
RegexEach | Every item of a list value must match the comparison value as a regular expression — a multi-select's each key; a value that is no list is one item, and nothing is an empty list. |
UIFieldBoxAlignment
Which field boxes a panel stands level with, or none.
| Member | Meaning |
|---|---|
None | Stands where it is laid out. |
Small | Level with small field boxes (UISize.Small). |
Medium | Level with medium field boxes (UISize.Medium). |
Large | Level with large field boxes (UISize.Large). |
UIGraphDirection
Which way the layered layout runs, from what nothing feeds to what feeds nothing.
| Member | Meaning |
|---|---|
LeftToRight | The layers stand side by side, the first at the left. |
TopToBottom | The layers stand one under another, the first at the top. |
RightToLeft | The layers stand side by side, the first at the right — read from what feeds nothing back to what nothing feeds. |
BottomToTop | The layers stand one under another, the first at the bottom. |
UIGraphEdgeShape
How an edge is drawn between two pins.
| Member | Meaning |
|---|---|
Bezier | A curve leaving each pin sideways. |
Straight | A straight line from pin to pin. |
Orthogonal | Horizontal and vertical runs with square corners. |
UIGraphNodeShape
How a graph's node is drawn.
| Member | Meaning |
|---|---|
Card | A card: the icon or picture, the title and the line under it, and the badge at its end. |
Icon | A circle holding the node's picture, or its icon when it has none, with the title standing under it and as its tooltip. |
UILayoutLengthKind
Defines the kind of layout length value.
| Member | Meaning |
|---|---|
Auto | The length is determined automatically based on content. |
Absolute | The length is a fixed value expressed in device-independent units. |
Fill | The whole of what the parent gives: a page that fills the viewport, a pane that fills its track. A component's own margin on that axis comes out of it, so a filled box with a margin still fits its parent. |
UILoadingStyle
The shape a spinner or a loading component draws while work is under way.
| Member | Meaning |
|---|---|
Ring | A turning circular ring. |
Dots | Three dots animated by a periodic vertical wave. |
UIPopupPlacement
Defines where a popup prefers to sit relative to its anchor; a side with no room for it flips to its opposite, and with room on neither, to a side across, so the popup never covers its own anchor where one of the four sides has room.
| Member | Meaning |
|---|---|
BottomStart | Below the anchor, aligned to its start edge. |
Bottom | Below the anchor, centered on it. |
BottomEnd | Below the anchor, aligned to its end edge. |
TopStart | Above the anchor, aligned to its start edge. |
Top | Above the anchor, centered on it. |
TopEnd | Above the anchor, aligned to its end edge. |
LeftStart | To the left of the anchor, aligned to its start edge. |
Left | To the left of the anchor, centered on it. |
LeftEnd | To the left of the anchor, aligned to its end edge. |
RightStart | To the right of the anchor, aligned to its start edge. |
Right | To the right of the anchor, centered on it. |
RightEnd | To the right of the anchor, aligned to its end edge. |
UIProductionMode
Which of its two uses a production graph is put to.
| Member | Meaning |
|---|---|
Constructor | The catalogue as it is: every resource and craft, one run's amounts on the edges, edited where the graph allows it. |
Plan | A plan over the catalogue: the viewer names target amounts, and the graph draws the crafts and resources that reach them. |
UIShape
The shape a picture is drawn in — an image standing alone, or an icon that is a picture; a glyph keeps its own whatever the shape.
| Member | Meaning |
|---|---|
Default | The picture's own: an image in the box the layout gives it, its corners as BorderRadius says; an icon's picture as it is, its corners slightly rounded. |
Circle | A circle the picture fills, a picture of another proportion cropped to its middle (an image's Fit may say otherwise) — a person, a team. |
UISize
How much room a control or a glyph takes, independent of what it holds: one scale for a button, a field, an icon and an indicator.
| Member | Meaning |
|---|---|
Small | Sized to sit inside a row, a toolbar, a list or a dense surface (a node on a canvas, a cell) without setting its height. |
Medium | The ordinary size — a button or a field standing on its own. |
Large | A call to action, where the control is the point of what it sits in. |
UITextBadgePlacement
Defines where a badge in text content is placed.
| Member | Meaning |
|---|---|
Inline | The badge is placed inline within the text content. |
Trailing | The badge is placed after the text content. |
UITextType
Defines semantic text roles used by text components.
| Member | Meaning |
|---|---|
Display | The largest, most prominent typographic role, for hero-style text. |
Title | The typographic role for primary headings. |
Subtitle | The typographic role for secondary headings. |
Body | The typographic role for regular body text. |
Caption | The typographic role for small, supplementary text. |
Overline | The typographic role for small label text placed above content. |
UIThemeMode
The two themes a surface can be forced into. null means "inherit" on a component and "follow the platform" on a session.
| Member | Meaning |
|---|---|
Light | Always uses the light theme. |
Dark | Always uses the dark theme. |
UIValidationPresentation
Where a field's validation message goes: a line under the field, or a mark at its edge that speaks in a tooltip.
| Member | Meaning |
|---|---|
Auto | A line under the field, except where the field sits in a table's cell, where it is a mark; an open key-value row keeps the line. |
Message | A line under the field, wherever the field is. |
Marker | A mark at the field's edge, the message in its tooltip; the field keeps its height. |
UIValidationSeverity
What a validation message means: an error stops a submit, a warning and an info only say something.
| Member | Meaning |
|---|---|
Error | Blocks a submit and draws both the required marker and the field's edge. |
Warning | Colours the field's edge but never blocks a submit. |
Info | Speaks only under the field, without touching its edge or blocking a submit. |
UIValidationTrigger
Defines when a UI validation rule is evaluated.
| Member | Meaning |
|---|---|
Change | The rule is evaluated whenever the value changes. |
Blur | The rule is evaluated when the input loses focus. |
Submit | The rule is evaluated when the form is submitted. |
UIVisibility
Defines what a component does with the room it was given: fills it, keeps it empty, or gives it back.
| Member | Meaning |
|---|---|
Visible | Drawn, and taking part in everything: layout, hit-testing, focus and assistive technology. |
Hidden | Not drawn, but still holding its place — the layout around it does not move. |
Collapsed | Gone from the layout as well: everything after it closes the gap. |