Skip to main content

TextElement

Namespace: Busy.Bar

A text label to display.

public sealed record class TextElement : DisplayElement, System.IEquatable`1[[Busy.Bar.DisplayElement, BusyBar, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.IEquatable`1[[Busy.Bar.TextElement, BusyBar, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Inheritance Object → DisplayElement → TextElement
Implements IEquatable<DisplayElement>, IEquatable<TextElement>
Attributes NullableContextAttribute, NullableAttribute, RequiredMemberAttribute

Properties​

Text​

Text content to display. Printable ASCII only, since fonts are bitmap ASCII.

public required string Text { get; init; }

Property Value​

String

Font​

Font to render the text in.

public required TextFont Font { get; init; }

Property Value​

TextFont

Color​

Text color, in #RRGGBBAA format.

public string Color { get; init; }

Property Value​

String

Width​

Width of the text label, in pixels.

public int? Width { get; init; }

Property Value​

Int32?

ScrollRate​

Scroll rate, in pixels per minute, for text that doesn't fit within TextElement.Width.

public int? ScrollRate { get; init; }

Property Value​

Int32?

ScrollStartDelay​

Delay, in milliseconds, before the scroll animation begins.

public int? ScrollStartDelay { get; init; }

Property Value​

Int32?

ScrollRepeatDelay​

Pause duration, in milliseconds, between successive scroll cycles.

public int? ScrollRepeatDelay { get; init; }

Property Value​

Int32?

Id​

Unique identifier for the element, used to update or remove it later.

public required string Id { get; init; }

Property Value​

String

Timeout​

Time in seconds the element should remain displayed (0 for no timeout). Mutually exclusive with DisplayElement.DisplayUntil.

public int? Timeout { get; init; }

Property Value​

Int32?

DisplayUntil​

Unix timestamp, in seconds, at which the element is hidden. Mutually exclusive with DisplayElement.Timeout.

public string? DisplayUntil { get; init; }

Property Value​

String

X​

X coordinate of the element's anchor point, relative to the top-left of the display.

public int X { get; init; }

Property Value​

Int32

Y​

Y coordinate of the element's anchor point, relative to the top-left of the display.

public int Y { get; init; }

Property Value​

Int32

Display​

Which display to draw the element on.

public DisplayTarget Display { get; init; }

Property Value​

DisplayTarget

Align​

Anchor point of the element, used together with DisplayElement.X/DisplayElement.Y to position it.

public ElementAlign? Align { get; init; }

Property Value​

ElementAlign?

Constructors​

TextElement()​

Caution​

Constructors of types with required members are not supported in this version of your compiler.

public TextElement()