NE.Standard

Text

Text content: an optional leading icon, a title, a description and a badge, each on one line unless it is told to wrap.

TextComponent · type key standard.text · Contents · property blocks: ITextMarkAlignmentComponent, ITextWrapComponent, IRenamableItemsComponent, IRenamableComponent

SetWrapMode(Wrap) lets the description run on, as a card's and an expander's header do by default, and SetTitleWrap(true) the title; text clamped to a number of lines, or set off as a quotation, is ParagraphComponent.

new TextComponent("text")

Properties

PropertyTypeDefaultBindingDescription
Own
IconAlignment
SetIconAlignment
UITextIconAlignment?UITextIconAlignment.Content—Where the leading icon sits against the text beside it: Content (the default) centres it across title and description, while Title keeps it on the title's own line.
BadgeAlignment
SetBadgeAlignment
UITextBadgeAlignment?UITextBadgeAlignment.Title—Where a trailing badge sits against the text beside it: Title (default) keeps it at the title line's end; Content centres it across title and description.
WrapMode
SetWrapMode · BindWrapMode
UITextWrapMode?UITextWrapMode.NoWrapone-wayWhether the description wraps onto further lines or keeps one line and ends in an ellipsis; unset, a paragraph's and a header's wrap and a text's keeps its line.
TitleWrap
SetTitleWrap · BindTitleWrap
bool?falseone-wayWhether the title runs on to further lines too: a heading in prose (an article's headline, a dialog's question, a card's flavour line) that must not lose its end. Unset, the title keeps one line and ends in an ellipsis, as every interface heading does.
Renamable
SetRenamable · BindRenamable
bool?falseone-wayWhether the component's or host's own gesture renames a title in place — F2 or double click; in a host, an item that says CanRename false keeps its title, while a rename the application asks for (RenameItemEffect, a menu's entry) opens the field either way.
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.
From TextComponentBase
DescriptionPlain
SetDescriptionPlain
bool?false—Whether the description is shown as written, its asterisks, brackets and braces as characters, rather than read as inline markup: words a person typed — a chat's message, an error's text from an address — bound to it; unset, it is markup.
Render-time only: the first paint and every value pushed later are written the same way.
HeadingLevel
SetHeadingLevel
int?null—The heading level (1 through 6) the title stands at in the page's outline; unset, the title is plain text.
Render-time only: the title's element (h1 through h6) is chosen when the block is drawn.
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.
Description
SetDescription · BindDescription
UIPhrasenullone-wayThe secondary text. translatable
DescriptionType
SetDescriptionType · BindDescriptionType
UITextAppearance?Bodyone-wayThe secondary text type.
DescriptionColor
SetDescriptionColor · BindDescriptionColor
UIThemeColor?Mutedone-wayThe secondary text color.
TextAlignment
SetTextAlignment · BindTextAlignment
UITextAlignment?UITextAlignment.Startone-wayHow the title and description align within their box — Start, Center, End, or Justify; default Start.
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?Titleone-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.Inlineone-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.
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.

Events

OnRename(string command)
Registers a command invoked after an inline rename wrote the text's new title back.
OnRename(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a command invoked after an inline rename wrote the text's new title back, with UI action arguments.
Optional: the two-way title already carries the new text; this is for refusing or normalizing it.
OnRenameLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a command invoked after an inline rename wrote the text's new title back, with literal argument values.
OnRenameWithItem(string command, string argumentName = "item")
Registers a command invoked after an inline rename wrote the text's new title back, passing the enclosing row's item as an argument.
OnRenameWithItemKey(string command, string argumentName = "id")
Registers a command invoked after an inline rename wrote the text's new title back, passing the enclosing row's key as an argument.
OnRenameWith(string command, string argumentName, UIActionArgumentKind argumentKind)
Registers a command invoked after an inline rename wrote the text's new title back, with an argument derived from the specified argumentKind.

Methods

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>?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.