Skip to main content

CountdownElement

Namespace: Busy.Bar

A live countdown (or count-up) timer to display.

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

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

Properties​

Timestamp​

Seconds-based Unix UTC timestamp, encoded as a numeric string per the API.

public required string Timestamp { get; init; }

Property Value​

String

Color​

Countdown text color, in #RRGGBBAA format.

public string Color { get; init; }

Property Value​

String

Direction​

Whether to count down to, or up from, CountdownElement.Timestamp.

public required CountdownDirection Direction { get; init; }

Property Value​

CountdownDirection

ShowHours​

When to show the hours position.

public required ShowHours ShowHours { get; init; }

Property Value​

ShowHours

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​

CountdownElement()​

Caution​

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

public CountdownElement()