Skip to main content

DisplayElement

Namespace: Busy.Bar

Unlike BusyTimerSettings/BusySnapshotState/StorageListElement, this library only ever serializes DisplayElement (as part of an outgoing DisplayDrawParams) — no BUSY Bar endpoint returns display elements back to the client, so System.Text.Json's discriminator-must-be-first constraint (which only applies to deserialization) never applies here.

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

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

Properties​

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​

DisplayElement(DisplayElement)​

protected DisplayElement(DisplayElement original)

Parameters​

original DisplayElement

DisplayElement()​

Caution​

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

protected DisplayElement()