Skip to main content

ImageElement

Namespace: Busy.Bar

Exactly one of ImageElement.Path or ImageElement.StockPath should be set.

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

Inheritance ObjectDisplayElement → ImageElement
Implements IEquatable<DisplayElement>, IEquatable<ImageElement>
Attributes NullableContextAttribute, NullableAttribute

Properties

Path

Path to the image file within the application's assets directory.

public string? Path { get; init; }

Property Value

String

StockPath

Name of a stock image file bundled on the device.

public string? StockPath { get; init; }

Property Value

String

Opacity

Opacity of the image, in the range [0, 100].

public int Opacity { 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

ImageElement()

Caution

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


public ImageElement()