NE.Standard

Tab item

One tab of a TabsViewComponent.

TabItemComponent · type key standard.tab-item · Navigation · property blocks: IItemAbilitiesComponent, IRenamableComponent

Not a ButtonComponent: the caption carries a close button, and a button inside a button is invalid markup.

new TabItemComponent("tab-item")

Properties

PropertyTypeDefaultBindingDescription
Order
SetOrder · BindOrder
double?nulltwo-way, relative scopeWhere this tab sits in the strip, ascending.
Bound two-way, but written by the server alone: a drag or a pin tells it where the tab goes, and it writes the orders that put it there, so reordering changes the item, not the collection. A page's own write of it is refused.
Pinned
SetPinned · BindPinned
bool?falsetwo-way, relative scopeWhether the tab is pinned: drawn with a pin, without its close control, and left where it is by a drag.
Whether a close from elsewhere is refused is the controller's answer. Two-way: the strip's tab menu pins and unpins, writing the new state back.
CanSelect
SetCanSelect · BindCanSelect
bool?nullone-wayWhether the row may be chosen; unset means it may.
False here or on the item (IItemAbilitiesModel), by a static value or a controller binding, the server refuses a choice that takes the row, as it does one that takes a disabled row. A guard against a stale or forged page, not the permission itself: who may choose belongs in the setter.
CanDrag
SetCanDrag · BindCanDrag
bool?nullone-wayWhether the row may be dragged, where its host drags at all; unset means it may.
False here or on the item, the server refuses the row's move — a tab's too — and a tree node's DropTarget, as it refuses a choice of a row not to be chosen: a guard against a stale or forged page, not the permission itself, which belongs in the command. A drop on another host (OnDrop) is its command's to check.
CanRemove
SetCanRemove · BindCanRemove
bool?nullone-wayWhether the row may be removed by the host's own gesture; unset means it may.
False here or on the item, the server refuses the row's remove — a guard against a stale or forged page, not the permission itself, which belongs in the command.
CanRename
SetCanRename · BindCanRename
bool?nullone-wayWhether the row may be renamed in place, where its host renames at all; unset means it may.
False here or on the item, the server refuses the row's rename and the title it writes back — a guard against a stale or forged page, not the permission itself, which belongs in the command or the setter.
CanShowContextMenu
SetCanShowContextMenu · BindCanShowContextMenu
bool?nullone-wayWhether a right-click on the row opens the menu its template carries; unset means it does.
RenamedTitle
SetRenamedTitle · BindRenamedTitle
stringnulltwo-wayThe title as a rename wrote it back; the component's own text draws the title.
The server refuses its write where the component's Renamable or its row's CanRename is false.

Events

OnRemove(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a command invoked when this tab's close is pressed; the controller removes the tab or leaves it.
OnRemoveLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a command invoked when this tab's close is pressed, with literal argument values.
OnRename(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a command invoked when this tab's caption is renamed in place.
OnRenameLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a command invoked when this tab's caption is renamed in place, with literal argument values.

Methods

ConfigureDefaultCaption(Action<TabCaptionRegion> configure)
Configures the built-in caption region.
SetPage(IVisualComponent page)
Sets the page this tab opens.
ConfigureTemplate(TTemplate? current, Action<TTemplate> configure, string what)
Configures current when it is a TTemplate, throwing when a different one was set.
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>?Stretchone-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.