NE.Standard

Multi select

An input that holds several options out of a bound list: chips in a field, the options' badges, or a checkbox per option.

MultiSelectComponent · type key standard.input.multi-select · Inputs

new MultiSelectComponent("multi-select")

Properties

PropertyTypeDefaultBindingDescription
From MultiSelectComponent
Variant
SetVariant
UIMultiSelectVariant?UIMultiSelectVariant.Chips—What the input is drawn as: chips in a field (the default), the options' badges in a field, or a checkbox per option.
Decided at render: a variant is how the input is built. MultiSelectComponent.SetVariant gives it its option template too.
ButtonVariant
SetButtonVariant · BindButtonVariant
UIButtonVariant?UIButtonVariant.Ghostone-wayThe button chrome variant used when MultiSelectComponent.Variant is UIMultiSelectVariant.Button.
MaxSelected
SetMaxSelected · BindMaxSelected
int?nullone-wayHow many options can be chosen at most; unset, any number. The list refuses one more once the field holds as many, and the checkboxes turn the unchecked ones off.
AllowFreeText
SetAllowFreeText
bool?false—Whether the reader may type values of their own — tags: an entry after the chips where Enter or a comma makes a chip of the text, the options standing as suggestions. A typed value's key is its text; MultiSelectComponent.MaxSelected and a RegexEach rule refuse one on the field's validation line before it becomes a chip.
Decided at render: it makes the entry, not the field's box, the control the reader types and lands in. Refused under UIMultiSelectVariant.Checkboxes, which has no field to type in: by the setters, and by MultiSelectComponent.ValidateConfiguration where the property is written past them.
TagEntry
SetTagEntry
UITagEntry?UITagEntry.TypedText—What Enter takes in a field taking free text while the reader types: the text as typed (the arrows pick a suggestion), or the first suggestion the text names, marked as it is typed. Nothing without MultiSelectComponent.AllowFreeText.
Decided at render, as MultiSelectComponent.AllowFreeText is: it is how the entry answers its keys.
Orientation
SetOrientation · BindOrientation
UIResponsive<UIOrientation>?Verticalone-wayWhich way the component runs, optionally per breakpoint (a column on a phone, a row wider up); vertical unless the component says otherwise.
Spacing
SetSpacing · BindSpacing
UIResponsive<double>?nullone-wayThe gap between the component's children or entries, optionally overridden per breakpoint.
Unset, the stylesheet's own gap for the component applies, which may depend on its shape.
ItemMinWidth
SetItemMinWidth
UIResponsive<double>?null—The narrowest a child may be, in pixels: set, the children stand in even columns as many to a line as fit at that width, each line's columns shared out equally, so a wrapped one stands under the one above; unset, each takes its content's width.
Authoring-only: how a set of controls is laid out is decided once by the view. The columns share out the width the component is given, so one sized to its content stands in a single column.
From SelectComponentBase
ShowChevron
SetShowChevron · BindShowChevron
bool?trueone-wayWhether the field draws the mark that says it opens a list.
BorderColor
SetBorderColor · BindBorderColor
UIThemeColor?nullone-wayThe border's colour, written as CSS border-color; unset leaves the stylesheet's own.
BorderThickness
SetBorderThickness · BindBorderThickness
UIResponsive<UIThickness>?nullone-wayThe border's thickness, optionally overridden per breakpoint; unset leaves the stylesheet's own.
A frame on a wide screen may run edge to edge on a phone: SetBorderThickness(UIThickness.Uniform(0), md: UIThickness.Uniform(1)).
BorderRadius
SetBorderRadius · BindBorderRadius
UIResponsive<UICornerRadius>?nullone-wayThe corner rounding, optionally overridden per breakpoint; unset leaves the stylesheet's own.
PrefixIcon
SetPrefixIcon · BindPrefixIcon
stringnullone-wayThe icon shown at the start of the field.
SuffixIcon
SetSuffixIcon · BindSuffixIcon
stringnullone-wayThe icon shown at the end of the field, before whatever control the input keeps there.
TitlePlacement
SetTitlePlacement
UIInputTitlePlacement?UIInputTitlePlacement.Top—Where the caption stands, decided once at render; a multi-line field's box always keeps it on top.
Appearance
SetAppearance · BindAppearance
UIInputAppearance?UIInputAppearance.Filledone-wayHow the field surface is drawn: UIInputAppearance.Filled unless set.
ShowFocusEdge
SetShowFocusEdge · BindShowFocusEdge
bool?trueone-wayWhether the field draws its focus contour while it holds the focus; off for a field its container and its caret already frame, as a composer that is a bubble's whole content.
Size
SetSize · BindSize
UIResponsive<UISize>?Mediumone-wayHow much room the input takes, optionally per breakpoint: a field's height, side padding and text; a toggle's box and text; a slider's track and handle.
Placeholder
SetPlaceholder · BindPlaceholder
UIPhrasenullone-wayThe hint shown while the input has no value. translatable
PopupPlacement
SetPopupPlacement · BindPopupPlacement
UIPopupPlacement?UIPopupPlacement.BottomStartone-wayWhere the popup opens against its anchor, flipping where there is no room; below from its start unless the component says otherwise. Read each time the popup opens.
ShowClearButton
SetShowClearButton · BindShowClearButton
bool?falseone-wayWhether a button that empties the value is shown; it stays out of the tab order, and is gone while the field is empty, read-only or disabled.
From InputTemplatedComponentBase
Value
SetValue · BindValue
IReadOnlyList<string>nulltwo-wayThe input's current value, boxed to Object; a concrete input also exposes its own typed Value alongside this one.
IsReadOnly
SetIsReadOnly · BindIsReadOnly
bool?falseone-wayWhether the input can be seen but not edited; unlike IVisualComponent.Enabled, a read-only value still submits and stays focusable.
True by a static value or a controller binding, the server refuses a value the input sends and answers it with the value it holds. A guard against a stale or forged page, not the permission itself: who may change the value belongs in the setter.
FormId
SetFormId · BindFormId
stringnullone-wayThe id of the form this input belongs to, used to scope Submit-trigger validation.
Settable through the contract, so a preset can join the fields it holds to its form (UIDialogs.Form).
Validation
SetValidation · BindValidation
UIValidationMessage?nullone-wayA message the controller puts on the field, beside whatever the client rules say; the strongest one shows.
ValidationPresentation
SetValidationPresentation
UIValidationPresentation?UIValidationPresentation.Auto—Where the message goes: a line under the field, or an edge mark with the message in a tooltip.
Decided once at render; UIValidationPresentation.Auto is the line except in a grid cell.
Icon
SetIcon · BindIcon
stringnullone-wayThe icon shown before the title, by name from the registered icon font/set.
IconColor
SetIconColor · BindIconColor
UIThemeColor?Defaultone-wayThe leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSize
SetIconSize · BindIconSize
UISize?nullone-wayThe leading icon size; left unset the glyph is as tall as the title beside it.
IconShape
SetIconShape · BindIconShape
UIShape?nullone-wayThe shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallback
SetIconFallback · BindIconFallback
stringnullone-wayThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
Title
SetTitle · BindTitle
UIPhrasenullone-wayThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleType
SetTitleType · BindTitleType
UITextAppearance?Captionone-wayThe primary text type.
TitleColor
SetTitleColor · BindTitleColor
UIThemeColor?Defaultone-wayThe primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacement
SetBadgePlacement · BindBadgePlacement
UITextBadgePlacement?UITextBadgePlacement.Trailingone-wayWhere badge content is placed.
BadgeVariant
SetBadgeVariant · BindBadgeVariant
UIBadgeVariant?UIBadgeVariant.Infoone-wayThe badge visual variant.
BadgeColor
SetBadgeColor · BindBadgeColor
UIThemeColor?nullone-wayThe badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFill
SetBadgeFill · BindBadgeFill
UIBadgeFill?nullone-wayHow the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIcon
SetBadgeIcon · BindBadgeIcon
stringnullone-wayThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColor
SetBadgeIconColor · BindBadgeIconColor
UIThemeColor?Defaultone-wayThe badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSize
SetBadgeIconSize · BindBadgeIconSize
UISize?nullone-wayThe badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitle
SetBadgeTitle · BindBadgeTitle
UIPhrasenullone-wayThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleType
SetBadgeTitleType · BindBadgeTitleType
UITextAppearance?Overlineone-wayThe role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltip
SetBadgeTooltip · BindBadgeTooltip
UIPhrasenullone-wayThe tooltip for the badge content. translatable
BadgeTooltipPlacement
SetBadgeTooltipPlacement · BindBadgeTooltipPlacement
UIPopupPlacement?UIPopupPlacement.Topone-wayThe side the badge's own tooltip prefers, placed against the badge rather than against the row.
TooltipPlain
SetTooltipPlain
bool?false—Whether the tooltip is shown as written, its asterisks, brackets and braces as characters, rather than read as inline markup: words the controller holds bound to it — a person's name, a note's status; unset, it is markup.
Render-time only: the first paint and every value pushed later are shown the same way.
Tooltip
SetTooltip · BindTooltip
UIPhrasenullone-wayThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacement
SetTooltipPlacement · BindTooltipPlacement
UIPopupPlacement?UIPopupPlacement.Topone-wayThe side the tooltip prefers; flips to the opposite side when there is no room for it there.
AccessibleName
SetAccessibleName · BindAccessibleName
UIPhrasenullone-wayThe name a screen reader announces in place of the visible words; unset, the control is named by what it shows. The set is a wrapper's hand (a labelled control is named by its label), an author's own words said at the component. translatable
From ItemsComponentBase
Items
SetItems · BindItems
IReadOnlyList<OptionItem>nullone-wayThe component items.
ItemsView
BindItemsView
UIItemsViewnullone-wayFiltering and sorting rules applied to the items collection.
Query
SetQuery · BindQuery
UIItemsQuerynulltwo-wayThe terms the viewer set after the view compiled (a header's sort, a filter row), applied beside the authored rules; two-way bound, so a windowed source is asked with them.
ItemReadsUIItemReadsnull—What the page reads off the rows beyond what the templates, rules and keys read — a client engine reading items raw — or null for nothing more; a row carries only what is read (UIItemReads.Whole sends it whole).
From TemplatedComponentBase
TemplateKeyProperty
SetTemplateKeyProperty
stringnull—The name of the item field whose value selects a named template variant.
Render-time only: the renderer and the runtime read it off the compiled state to pick a variant, so a binding would change nothing.
FallbackTemplateKey
SetFallbackTemplateKey
stringnull—The fallback template key used when ITemplatedComponent.TemplateKeyProperty does not resolve to a template.

Events

OnChange(string command)
Registers a change event command.
OnChange(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a change event command with action arguments.
OnChangeLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a change event command with literal argument values.
OnBlur(string command)
Registers a blur event command.
OnBlur(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a blur event command with action arguments.
OnBlurLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a blur event command with literal argument values.

Methods

SetTrailingAction(IButtonComponent action)
Puts a button at the end of the field, in place of any there before; the field lays it in and dresses it as an adornment.
SetTrailingAction(FlyoutComponent flyout)
Puts a flyout at the end of the field, in place of any action there before: its anchor, a button, dressed as an adornment, and its content opening from it.
SetTrailingAction(IMultiSelectComponent select)
Puts a button-variant multi-select at the end of the field, in place of any action there before.
AddLeadingAction(IButtonComponent action)
Adds a button at the start of the field, after those added before; the field dresses it as an adornment.
AddLeadingAction(FlyoutComponent flyout)
Adds a flyout at the start of the field, after the actions added before: its anchor, a button, dressed as an adornment, and its content opening from it.
AddLeadingAction(IMultiSelectComponent select)
Adds a button-variant multi-select at the start of the field, after the actions added before.
AddTrailingAction(IButtonComponent action)
Adds a button at the end of the field, after those added before; the field dresses it as an adornment.
AddTrailingAction(FlyoutComponent flyout)
Adds a flyout at the end of the field, after the actions added before: its anchor, a button, dressed as an adornment, and its content opening from it.
AddTrailingAction(IMultiSelectComponent select)
Adds a button-variant multi-select at the end of the field, after the actions added before.
ConfigureDefaultGroupTemplate(Action<DefaultGroupTemplate> configure)
Configures the built-in default group template, throwing if a different template has been set.
AddOption(OptionItem option)
Adds a single option to the list.
AddOptions(IEnumerable<OptionItem> options)
Adds multiple options to the list.
SetOptions(IEnumerable<OptionItem> options)
Replaces the list of options.
BindOptions(string path, UIBindingScope scope = UIBindingScope.Root, UIBindingMode mode = UIBindingMode.OneWay)
Binds the list of options to a property at the given string path.
BindOptions(RecursivePath path, UIBindingScope scope = UIBindingScope.Root, UIBindingMode mode = UIBindingMode.OneWay)
Binds the list of options to a property at the given recursive path.
BindOptions(Expression<Func<TSource, object>> path, UIBindingScope scope = UIBindingScope.Root, UIBindingMode mode = UIBindingMode.OneWay)
Binds the list of options to a property at the given typed path expression.
SetHeaderAction(IVisualComponent action)
Sets the control the caption row carries at its far edge, keeping the row at one caption line's height.
SetGroupTemplate(IVisualComponent template)
Sets the template used to render item groups.
SetTemplate(ITextComponent visualTemplate)
Sets the item template.
AddTemplateVariant(string key, ITextComponent visualTemplate)
Adds or replaces a named template variant.
AddItemReads(params Expression<Func<TRow, object>>[] paths)
Names item paths the page reads off the rows beyond what the templates bind, so each row carries them.
AddItemReads(params string[] paths)
Names item paths the page reads off the rows beyond what the templates bind (a client engine reading rows.itemOf), so each row carries them; dotted, as a binding's path.
ReadsWholeItems()
Sends every row's item whole: something on the page reads it raw, past what the compile can see.
AddItem(OptionItem item)
Adds an item to the component.
AddItems(IEnumerable<OptionItem> items)
Adds items to the component.
FilterBy(UIProperty source, Expression<Func<TRow, object>> itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)
Adds a filter controlled by a local component property.
FilterBy(UIProperty source, string itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)
Adds a filter controlled by a local component property.
Defaults to a case-insensitive substring match; pass the operator explicitly where case matters.
FilterBy(string sourceComponentId, UIProperty source, Expression<Func<TRow, object>> itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)
Adds a filter controlled by another component property.
FilterBy(string sourceComponentId, UIProperty source, string itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)
Adds a filter controlled by another component property.
FilterBy(UIPropertyReference source, Expression<Func<TRow, object>> itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)
Adds a filter controlled by a property reference.
FilterBy(UIPropertyReference source, string itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)
Adds a filter controlled by a property reference.
FilterBy(Expression<Func<TRow, object>> itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, object? value = null)
Adds an unconditionally active filter with no source, comparing against a constant value.
FilterBy(string itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, object? value = null)
Adds an unconditionally active filter with no source, comparing against a constant value.
SortBy(UIProperty source, Expression<Func<TRow, object>> itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)
Adds a sort rule controlled by a local component property.
SortBy(UIProperty source, string itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)
Adds a sort rule controlled by a local component property.
SortBy(string sourceComponentId, UIProperty source, Expression<Func<TRow, object>> itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)
Adds a sort rule controlled by another component property.
SortBy(string sourceComponentId, UIProperty source, string itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)
Adds a sort rule controlled by another component property.
SortBy(UIPropertyReference source, Expression<Func<TRow, object>> itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)
Adds a sort rule controlled by a property reference.
SortBy(UIPropertyReference source, string itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)
Adds a sort rule controlled by a property reference.
SortBy(Expression<Func<TRow, object>> itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, int priority = 0)
Adds an unconditionally active sort rule with no source.
SortBy(string itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, int priority = 0)
Adds an unconditionally active sort rule with no source.
SetEmptyTemplate(IVisualComponent visualTemplate)
Sets the template used when there are no items or no content.
ConfigureDefaultEmptyTemplate(Action<DefaultEmptyTemplate> configure)
Configures the built-in default empty template, putting it in where the host has none, and throwing if a different template has been set.
On demand on every host, so a menu or a key-value list that starts with none (an empty context menu says nothing) and a list that starts with one are worded alike.
ConfigureTemplate(TTemplate? current, Action<TTemplate> configure, string what)
Configures current when it is a TTemplate, throwing when a different one was set.
ValidationInto(IVisualComponent targetComponent, UIProperty property)
Sends this field's validation message to another component's property, leaving the field its edge colour alone.
ValidationInto(string componentId, UIProperty property)
Sends this field's validation message to another component's property, leaving the field its edge colour alone.
Required(string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a required-value validation rule; its message is the author's text or a key.
Required(UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a required-value validation rule whose message is a phrase, such as a key with its arguments.
Regex(string pattern, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a regular-expression validation rule; its message is the author's text or a key.
Regex(string pattern, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a regular-expression validation rule whose message is a phrase, such as a key with its arguments.
RegexEach(string pattern, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule every item of a list value must match — a multi-select's each key, and a tag typed into one with free text is refused before it becomes a chip; its message is the author's text or a key.
RegexEach(string pattern, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule every item of a list value must match, whose message is a phrase, such as a key with its arguments.
Validate(UIValidationTrigger trigger, UIComparisonOperator operator, object? value, string message, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a validation rule; its message is the author's text or a key, looked up as a plain value on a translatable property is.
Validate(UIValidationTrigger trigger, UIComparisonOperator operator, object? value, UIPhrase message, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a validation rule whose message is a phrase: a key with its arguments — a limit's {max} — or UIPhrase.Text.
ValidateAgainst(IInputComponent sourceComponent, UIComparisonOperator operator, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule comparing the value with another field's — "Password again" Equal to "New password" — judged in the browser as either changes; its message is the author's text or a key.
ValidateAgainst(string componentId, UIComparisonOperator operator, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule comparing the value with another field's — "Password again" Equal to "New password" — judged in the browser as either changes; its message is the author's text or a key.
ValidateAgainst(IInputComponent sourceComponent, UIComparisonOperator operator, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule comparing the value with another field's, whose message is a phrase, such as a key with its arguments.
ValidateAgainst(string componentId, UIComparisonOperator operator, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule comparing the value with another field's, whose message is a phrase, such as a key with its arguments.
Common properties (23) — layout, visibility, theme, and the rest every component shares
PropertyTypeDefaultBindingDescription
Visibility
SetVisibility · BindVisibility
UIResponsive<UIVisibility>?Visibleone-wayWhat the component does with the room it was given, optionally overridden per breakpoint (e.g. collapsed from a given width up).
Hidden at every width — by a static value or a controller binding — the server refuses a command or a value the component or anything inside it sends. That is a guard against a stale or forged page, not the permission itself: an interaction that hides it (HiddenWhen) lives on the client alone, so who may act belongs in the command or the setter.
Enabled
SetEnabled · BindEnabled
bool?trueone-wayWhether the component responds to input; false dims it and marks it, and its subtree, inert.
False by a static value or a controller binding, the server refuses a command or a value the component or anything inside it sends. That is a guard against a stale or forged page, not the permission itself: an interaction that disables it (EnabledWhen) lives on the client alone, so who may act belongs in the command or the setter.
Theme
SetTheme · BindTheme
UIThemeMode?nullone-wayThe theme mode forced on this component's subtree, or null to inherit the ambient theme.
HorizontalAlignment
SetHorizontalAlignment · BindHorizontalAlignment
UIResponsive<UIAlignment>?Stretchone-wayWhere the component sits within its grid cell along the horizontal axis, optionally overridden per breakpoint.
VerticalAlignment
SetVerticalAlignment · BindVerticalAlignment
UIResponsive<UIAlignment>?Centerone-wayWhere the component sits within its grid cell along the vertical axis, optionally overridden per breakpoint.
Width
SetWidth · BindWidth
UIResponsive<UILayoutLength>?nullone-wayThe component width, optionally overridden per breakpoint.
MinWidth
SetMinWidth · BindMinWidth
UIResponsive<UILayoutLength>?nullone-wayThe component minimum width, optionally overridden per breakpoint.
MaxWidth
SetMaxWidth · BindMaxWidth
UIResponsive<UILayoutLength>?nullone-wayThe component maximum width, optionally overridden per breakpoint.
Height
SetHeight · BindHeight
UIResponsive<UILayoutLength>?nullone-wayThe component height, optionally overridden per breakpoint.
MinHeight
SetMinHeight · BindMinHeight
UIResponsive<UILayoutLength>?nullone-wayThe component minimum height, optionally overridden per breakpoint.
MaxHeight
SetMaxHeight · BindMaxHeight
UIResponsive<UILayoutLength>?nullone-wayThe component maximum height, optionally overridden per breakpoint.
ZIndex
SetZIndex · BindZIndex
int?0one-wayThe stacking order within the visual tree.
Margin
SetMargin · BindMargin
UIResponsive<UIThickness>?nullone-wayThe outer spacing around the component, optionally overridden per breakpoint.
Placement
SetPlacement · BindPlacement
UIResponsive<UIGridPlacement>?nullone-wayThe grid placement, optionally overridden per breakpoint.
AlignWithFieldBoxes
SetAlignWithFieldBoxes
UIResponsive<UIFieldBoxAlignment>?null—Whether the component stands level with the boxes of captioned fields beside it — a caption line down, centred on the box — and on which boxes, per breakpoint. Unset, the compiler decides it wherever the component stands side by side with a thing that draws a caption row (UIFieldBoxes); UIFieldBoxAlignment.None keeps it where it is laid out.
Render-time only. A panel draws it as its top padding and its least height, anything else as its top margin, set down onto the band's middle; an authored Padding, MinHeight or Margin replaces them.
Loading
SetLoading · BindLoading
bool?falseone-wayWhether the component is in loading state — a live state a controller turns on and off.
While it holds, by a static value or a controller binding, the server refuses a command or a value the component or anything inside it sends — as the page does.
LoadingStyle
SetLoadingStyle · BindLoadingStyle
UILoadingStyle?nullone-wayThe visual indicator shown while this component or spinner is loading, or null to inherit the ambient or theme loading style.
ShowContextMenu
SetShowContextMenu · BindShowContextMenu
bool?trueone-wayWhether a right-click opens the IVisualComponent.ContextMenu; on a host with rows, whether it opens any row's. Off, the menu stays in the tree and nothing opens it.
ActionBar
SetActionBar
UIActionBarAlignment?null—How the component's action bar lines up with it, or null for none: the IVisualComponent.ContextMenu's entries marked for the bar (a menu item's InActionBar) as icons, and "more" opening the menu itself, floating above the component once the reader chooses it — a press, a tap, the keyboard's cursor — until a press elsewhere, Escape, or another chosen.
A quick view of the menu, not a second list: a press on an icon is that entry's press. Render-time only; a component with an action bar and no context menu is refused when the view compiles.
ActionBarRepeatInMore
SetActionBarRepeatInMore
bool?true—Whether the menu the IVisualComponent.ActionBar's "more" opens repeats the entries the bar shows (the default), or holds the rest alone — no caption or rule left with nothing to stand over or between. A right-click and a long press open the whole menu either way, and a bar whose menu holds nothing more draws no "more".
Render-time only.
ScrollGroup
SetScrollGroup · BindScrollGroup
stringnullone-wayThe scroll group this component belongs to: every component sharing the name scrolls together.
Driven by whichever one the reader scrolls. Components that mark their shown source lines (e.g. a code field and a Markdown display) sync line-for-line; otherwise by scroll fraction.
TextSelectable
SetTextSelectable · BindTextSelectable
bool?nullone-wayWhether the reader can select the words in this component and everything inside it: true lets them (a table whose cells are copied, a chat bubble), false keeps them out; unset, the place decides — a Text's and a Paragraph's words and a validation message select, unless they stand in a row, a menu or another control, and nothing else does. The nearest component that says wins.
A control's own words (a button's label, a tab, a menu entry, a field's caption), a surface the pointer drags (a row that drags by itself, a canvas, a grip) and, on a touch screen, anything a long press opens a menu on never select; a field's value always does.
WindowFoot
SetWindowFoot
bool?null—Whether this component is the window's foot (a chat's composer, a pane's last row): where it stands at the window's bottom edge the phone's system bar takes its background colour, dimmed by any open modal drawer or dialog veil, and its content sits above the bar. The page's bottom bar is one by itself.
Render-time only.