Table
A table that shows the rows of a keyed collection under a header, one template per column.
Sorting by header, editing and paging are an add-on's.
new TableComponent("table")
Properties
| Property | Type | Default | Binding | Description |
|---|---|---|---|---|
| Own | ||||
Columns | IReadOnlyList<UITableColumn> | null | — | The columns in order; each one's cell template is the table's template variant keyed by the column. translatable Render-time only: the columns are how the table is built. Their captions are its words, so AsContent(ColumnsProperty) shows every caption as written, as UITableColumn.IsContent does one column's. |
ShowHeaderSetShowHeader · BindShowHeader | bool? | true | one-way | Whether the header row of captions is shown. |
StripedSetStriped · BindStriped | bool? | false | one-way | Whether every other row is tinted. |
ShowColumnSeparatorsSetShowColumnSeparators · BindShowColumnSeparators | bool? | false | one-way | Whether a line is drawn between columns. |
ShowRowSeparatorsSetShowRowSeparators · BindShowRowSeparators | bool? | true | one-way | Whether a line is drawn between rows. |
ResizableColumnsSetResizableColumns · BindResizableColumns | bool? | false | one-way | Whether the viewer may drag a column's edge in the header to resize it; the widths stay on the client. |
ReorderableColumnsSetReorderableColumns · BindReorderableColumns | bool? | false | one-way | Whether the viewer may drag a column by its caption to reorder it; the order stays client-side, like widths. Pinned columns and a control's own column keep their place. |
BorderColorSetBorderColor · BindBorderColor | UIThemeColor? | null | one-way | The border's colour, written as CSS border-color; unset leaves the stylesheet's own. |
BorderThicknessSetBorderThickness · BindBorderThickness | UIResponsive<UIThickness>? | null | one-way | The 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)). |
BorderRadiusSetBorderRadius · BindBorderRadius | UIResponsive<UICornerRadius>? | null | one-way | The corner rounding, optionally overridden per breakpoint; unset leaves the stylesheet's own. |
SurfaceSetSurface · BindSurface | UISurfaceStyle? | UISurfaceStyle.Background | one-way | What the component is made of. |
HostMode | UIItemsHostMode? | UIItemsHostMode.Plain | — | How the host holds its rows. Set by Virtualized() or by binding a source, never directly. |
WindowSizeSetWindowSize | int? | 50 | — | How many items one window holds. |
PagingSetPaging · BindPaging | bool? | false | one-way | Whether a windowed host shows its window as a page of IItemsHostComponent.WindowSize rows: the scroll asks for no window, and a pager aimed at the host, or Page Up and Page Down in it, asks for another by offset. A host holding its rows whole has nothing to page. |
WindowOffset | int? | null | — | Where the realized window starts, as the source last reported it. This and the three below are bound by the compiler only; binding one by hand is refused. |
WindowTotalCount | int? | null | — | How many items the source holds, as it last reported. |
WindowHasMoreBefore | bool? | false | — | Whether the source has items before the realized window. |
WindowHasMoreAfter | bool? | false | — | Whether the source has items after the realized window. |
WindowGroupBefore | string | null | — | The group of the item just before the realized window, as the source last reported it; bound by the compiler only. |
WindowAggregates | IReadOnlyDictionary<string, object> | null | — | What the source computed over every item the query leaves, by item property, as it last reported; bound by the compiler only. |
HorizontalScrollSetHorizontalScroll · BindHorizontalScroll | UIScrollMode? | UIScrollMode.Auto | one-way | Whether the viewport scrolls horizontally — Disabled, Auto, or Always; default Disabled. |
VerticalScrollSetVerticalScroll · BindVerticalScroll | UIScrollMode? | UIScrollMode.Auto | one-way | Whether the viewport scrolls vertically — Disabled, Auto, or Always; default Auto. |
ScrollSnapSetScrollSnap · BindScrollSnap | UIScrollSnapMode? | UIScrollSnapMode.Disabled | one-way | Whether a scroll comes to rest on a child's edge rather than wherever it was let go. |
ScrollAnchorSetScrollAnchor · BindScrollAnchor | UIScrollAnchor? | UIScrollAnchor.None | one-way | How the viewport reacts when its content grows. Applies to the component's own scrolling element, reaching a windowed host a wrapping ScrollContainer could not. |
ScrollFadeSetScrollFade · BindScrollFade | bool? | false | one-way | Whether the viewport softly fades its top and bottom edges while content is scrolled beneath them; default false. |
SelectionModeSetSelectionMode · BindSelectionMode | UISelectionMode? | UISelectionMode.None | one-way | How many rows may be chosen at once. |
SelectedKeysSetSelectedKeys · BindSelectedKeys | IReadOnlyList<string> | null | two-way | The keys of the chosen rows under UISelectionMode.Many, in the order they were chosen. |
SelectedKeySetSelectedKey · BindSelectedKey | string | null | two-way | The key of the chosen part — a host's row under UISelectionMode.One, a strip's segment, the tab shown; two-way, so the reader's choice writes the new key back. |
SelectionStyleSetSelectionStyle · BindSelectionStyle | UISelectionStyle? | null | one-way | What a chosen item looks like. Unset, and every unset part of it, is the control's own default. |
RowHoverableSetRowHoverable · BindRowHoverable | bool? | false | one-way | Whether rows highlight under the pointer; off by default unless the host turns it on for itself. |
ShowEmptyTemplateSetShowEmptyTemplate · BindShowEmptyTemplate | bool? | true | one-way | Whether the empty template is drawn while the host holds nothing; on by default. |
DragHandleSetDragHandle · BindDragHandle | bool? | false | one-way | Whether a IDraggableItemsComponent.Draggable row is dragged only by its grip (IDraggableRowsComponent.DragHandlePlacement); the rest of the row keeps its text selection and its presses, and the keyboard still moves rows by Alt+Up and Alt+Down. A table draws the grips in a narrow track of their own; a wrapped items view draws none, and its tiles drag whole. |
DragHandlePlacementSetDragHandlePlacement · BindDragHandlePlacement | UIDragHandlePlacement? | UIDragHandlePlacement.End | one-way | Where a row's grip stands (IDraggableRowsComponent.DragHandle): at its end by default, or at its start — in a table, the grips' track past the last column or before the first, pinned with it where the first column is pinned. |
DraggableSetDraggable · BindDraggable | bool? | false | one-way | Whether an item that does not refuse it (CanDrag) can be dragged to another place, or moved one place by Alt with an arrow; the move raises move, and the server refuses the move of an item that says CanDrag false. |
DragKindSetDragKind | string | null | — | The kind the host's items are offered as, dragged or cut out of it — lower-case letters, digits and hyphens — or null for none. A tree's folder goes with what it holds. |
DragEffectsSetDragEffects | UIDragEffects? | UIDragEffects.All | — | What a drop may do with the items: move them out of the host, copy them, or either, the drop deciding. |
AccessibleNameSetAccessibleName · BindAccessibleName | UIPhrase | null | one-way | The 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 | ||||
ItemsSetItems · BindItems | IReadOnlyList<IBindableItem> | null | one-way | The component items. |
ItemsViewBindItemsView | UIItemsView | null | one-way | Filtering and sorting rules applied to the items collection. |
QuerySetQuery · BindQuery | UIItemsQuery | null | two-way | The 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. |
ItemReads | UIItemReads | null | — | 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 | ||||
TemplateKeyPropertySetTemplateKeyProperty | string | null | — | 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. |
FallbackTemplateKeySetFallbackTemplateKey | string | null | — | The fallback template key used when ITemplatedComponent.TemplateKeyProperty does not resolve to a template. |
Events
OnMovableItemTemplates(Action<IVisualComponent> register)- Writes a move registration on the row template, now and on every one
RowItemsComponentBase.SetRowTemplatesets later: a row dropped at another place among the rows by a drag withDraggableon, or Alt+Up and Alt+Down.
The row stands there at once; the controller's Move of it keeps it there or puts it where the controller did, and an answer without one puts it back. The index is whereRecursiveCollection.Moveputs it; in a windowed host, its place in the source's whole query. OnClickableItemTemplates(Action<IVisualComponent> register)- Writes a click registration on the row template, now and on every one
RowItemsComponentBase.SetRowTemplatesets later. OnOpenableItemTemplates(Action<IVisualComponent> register)- Writes an open registration on the row template, now and on every one
RowItemsComponentBase.SetRowTemplatesets later. OnRemovableItemTemplates(Action<IVisualComponent> register)- Writes a remove registration on the row template, now and on every one
RowItemsComponentBase.SetRowTemplatesets later.
The Delete key raises it only on a row that may be removed; the controller removes the row or leaves it. OnItemClick(string command)- Registers a click command invoked when an item is clicked.
OnItemClick(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a click command invoked when an item is clicked, with UI action arguments.
OnItemClick(ClientEffect effect)- Runs a client effect when any item is clicked — a menu's or a split button's entries inserting their own key with
InsertTextEffect.CurrentItemKey— with no round trip. OnItemClick(string key, ClientEffect effect)- Runs a client effect when the item whose key is
keyis clicked — a menu's Copy, a context menu's or an action bar's entry, a split button's — with no round trip; the other items keep the commandOnItemClickgave them.
The key is the item's, so a bound list's entries take it as a declared one's do; an effect aimed at the row the menu stands in (a message's text) finds it there. Only an effect an interaction may run is taken. Given twice for one key, both run. OnItemClickLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a click command invoked when an item is clicked, with literal argument values.
OnItemClickWithItem(string command, string argumentName = "item")- Registers a click command that passes the clicked item as an argument.
OnItemClickWithItemKey(string command, string argumentName = "id")- Registers a click command that passes the clicked item's key as an argument.
OnItemClickWith(string command, string argumentName, UIActionArgumentKind argumentKind)- Registers a click command with an argument derived from the specified
argumentKind. OnItemMove(string command)- Registers a command invoked when an item is moved to another place — a drag with
Draggableon, or Alt with an arrow. OnItemMove(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a command invoked when an item is moved to another place, with UI action arguments.
The controller moves the item, keeps it where the page put it, or refuses by doing nothing. OnItemMoveLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a command invoked when an item is moved to another place, with literal argument values.
OnItemMoveWithItem(string command, string argumentName = "item", string indexArgumentName = "index")- Registers a command invoked when an item is moved to another place, passing the item and the index it takes.
OnItemMoveWithItemKey(string command, string keyArgumentName = "id", string indexArgumentName = "index")- Registers a command invoked when an item is moved to another place, passing the item's key and the index it takes.
OnItemMoveWith(string command, string argumentName, UIActionArgumentKind argumentKind, string indexArgumentName = "index")- Registers a command invoked when an item is moved to another place, passing an argument derived from the specified
argumentKindand the index it takes. OnItemOpen(string command)- Registers a command invoked when an item is opened — Enter on the keyboard's row, or a double click.
OnItemOpen(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a command invoked when an item is opened, with UI action arguments.
OnItemOpenLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a command invoked when an item is opened, with literal argument values.
OnItemOpenWithItem(string command, string argumentName = "item")- Registers a command invoked when an item is opened, passing the item as an argument.
OnItemOpenWithItemKey(string command, string argumentName = "id")- Registers a command invoked when an item is opened, passing the item's key as an argument.
OnItemOpenWith(string command, string argumentName, UIActionArgumentKind argumentKind)- Registers a command invoked when an item is opened, with an argument derived from the specified
argumentKind. OnItemRemove(string command)- Registers a command invoked when an item is asked to be removed — the Delete key on a row that may be removed, or a tab's close.
OnItemRemove(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a command invoked when an item is asked to be removed, with UI action arguments.
The controller removes the item or leaves it; a chosen group under the cursor raises it once per item. OnItemRemoveLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a command invoked when an item is asked to be removed, with literal argument values.
OnItemRemoveWithItem(string command, string argumentName = "item")- Registers a command invoked when an item is asked to be removed, passing the item as an argument.
OnItemRemoveWithItemKey(string command, string argumentName = "id")- Registers a command invoked when an item is asked to be removed, passing the item's key as an argument.
OnItemRemoveWith(string command, string argumentName, UIActionArgumentKind argumentKind)- Registers a command invoked when an item is asked to be removed, with an argument derived from the specified
argumentKind.
Methods
AddColumn(UIPhrase caption, IVisualComponent template, UIGridUnit? width = null, UITextAlignment? alignment = null, string? key = null, bool pinned = false, string? icon = null, bool hidden = false, bool content = false)- Adds a column rendering
templateagainst the row, bound relatively to the row's properties.
Defaults toUIGridUnit.Autowidth and a positional key; apinnedcolumn stays fixed while the table scrolls, and pinned columns must lead;iconstands before the caption, ahiddencolumn starts hidden, and acontentcaption is shown as written. The caption is a phrase: a string is the author's text, a key with arguments a phrase. Virtual, asTableComponent.AddTextColumnis: a package's grid builds its own column through the same verb. HideColumnBelow(string key, UIResponsiveTier tier)- Hides the column keyed
keybelow viewporttier; a viewer's chooser may still show it.
Applied after the column is added, so the adding verbs stay short. HideColumn(string key)- Starts the column keyed
keyhidden at every width; a viewer's chooser may still show it, and that word is kept.
Applied after the column is added, asTableComponent.HideColumnBelowis. A plain table draws no chooser, so only a host that has one (the data grid) can show the column again. SetColumnIcon(string key, string? icon, UIThemeColor? color = null)- Draws
icon, incolorwhen given, before the caption of the column keyedkey. SetRowHeaderColumn(string key)- Makes the column keyed
keyname its rows (UITableColumn.IsRowHeader) in place of the first column, which heads them while no column is marked. AddTextColumn(UIPhrase caption, Expression<Func<TRow, object>> propertyPath, UIGridUnit? width = null, UITextAlignment? alignment = null, string? key = null, bool pinned = false, string? icon = null, bool hidden = false, bool content = false)- Adds a column showing the row's text at
propertyPath— a string property, in the row's own words. AddTextColumn(UIPhrase caption, string propertyPath, UIGridUnit? width = null, UITextAlignment? alignment = null, string? key = null, bool pinned = false, string? icon = null, bool hidden = false, bool content = false)- Adds a column showing the row's text at
propertyPath— a string property, in the row's own words. Virtualized()- Keeps only the rows in view in the document, for a collection the client holds whole.
BindSource(string path, UIBindingScope scope = UIBindingScope.Root)- Binds the table's rows to a windowed source on the controller.
The path names the source; the compiler appends the property holding its realized window. BindSource(Expression<Func<TSource, object>> path, UIBindingScope scope = UIBindingScope.Root)- Binds the table's rows to a windowed source on the controller.
The path names the source; the compiler appends the property holding its realized window. SetRowTemplate(DefaultRowTemplate template)- Sets the row template.
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(IBindableItem item)- Adds an item to the component.
AddItems(IEnumerable<IBindableItem> 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
currentwhen it is aTTemplate, throwing when a different one was set. AnchorToEnd()- Follows content appended at the end while the viewer is already at the end.
DisableScroll()- Disables both horizontal and vertical scrolling.
VerticalScrollOnly()- Enables vertical scrolling only.
HorizontalScrollOnly()- Enables horizontal scrolling only.
BothScroll()- Enables both horizontal and vertical scrolling.
SetScroll(UIScrollMode horizontalScroll, UIScrollMode verticalScroll)- Sets the horizontal and vertical scroll behaviors.
Common properties (23) — layout, visibility, theme, and the rest every component shares
| Property | Type | Default | Binding | Description |
|---|---|---|---|---|
VisibilitySetVisibility · BindVisibility | UIResponsive<UIVisibility>? | Visible | one-way | What 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. |
EnabledSetEnabled · BindEnabled | bool? | true | one-way | Whether 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. |
ThemeSetTheme · BindTheme | UIThemeMode? | null | one-way | The theme mode forced on this component's subtree, or null to inherit the ambient theme. |
HorizontalAlignmentSetHorizontalAlignment · BindHorizontalAlignment | UIResponsive<UIAlignment>? | Stretch | one-way | Where the component sits within its grid cell along the horizontal axis, optionally overridden per breakpoint. |
VerticalAlignmentSetVerticalAlignment · BindVerticalAlignment | UIResponsive<UIAlignment>? | Stretch | one-way | Where the component sits within its grid cell along the vertical axis, optionally overridden per breakpoint. |
WidthSetWidth · BindWidth | UIResponsive<UILayoutLength>? | null | one-way | The component width, optionally overridden per breakpoint. |
MinWidthSetMinWidth · BindMinWidth | UIResponsive<UILayoutLength>? | null | one-way | The component minimum width, optionally overridden per breakpoint. |
MaxWidthSetMaxWidth · BindMaxWidth | UIResponsive<UILayoutLength>? | null | one-way | The component maximum width, optionally overridden per breakpoint. |
HeightSetHeight · BindHeight | UIResponsive<UILayoutLength>? | null | one-way | The component height, optionally overridden per breakpoint. |
MinHeightSetMinHeight · BindMinHeight | UIResponsive<UILayoutLength>? | null | one-way | The component minimum height, optionally overridden per breakpoint. |
MaxHeightSetMaxHeight · BindMaxHeight | UIResponsive<UILayoutLength>? | null | one-way | The component maximum height, optionally overridden per breakpoint. |
ZIndexSetZIndex · BindZIndex | int? | 0 | one-way | The stacking order within the visual tree. |
MarginSetMargin · BindMargin | UIResponsive<UIThickness>? | null | one-way | The outer spacing around the component, optionally overridden per breakpoint. |
PlacementSetPlacement · BindPlacement | UIResponsive<UIGridPlacement>? | null | one-way | The grid placement, optionally overridden per breakpoint. |
AlignWithFieldBoxesSetAlignWithFieldBoxes | 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. |
LoadingSetLoading · BindLoading | bool? | false | one-way | Whether 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. |
LoadingStyleSetLoadingStyle · BindLoadingStyle | UILoadingStyle? | null | one-way | The visual indicator shown while this component or spinner is loading, or null to inherit the ambient or theme loading style. |
ShowContextMenuSetShowContextMenu · BindShowContextMenu | bool? | true | one-way | Whether 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. |
ActionBarSetActionBar | 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. |
ActionBarRepeatInMoreSetActionBarRepeatInMore | 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. |
ScrollGroupSetScrollGroup · BindScrollGroup | string | null | one-way | The 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. |
TextSelectableSetTextSelectable · BindTextSelectable | bool? | null | one-way | Whether 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. |
WindowFootSetWindowFoot | 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. |