Class BarConfig

Namespace

Whim.Bar

Assembly

Whim.Bar.dll

Configuration for the bar plugin.

public class BarConfig : INotifyPropertyChanged

Inheritance

object

BarConfig

Implements

INotifyPropertyChanged

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The components lists can be changed up until when Whim is initialized.

Constructors

BarConfig(IList<BarComponent>, IList<BarComponent>, IList<BarComponent>)

Configuration for the bar plugin.

public BarConfig(IList<BarComponent> leftComponents, IList<BarComponent> centerComponents, IList<BarComponent> rightComponents)

Parameters

leftComponents IList<BarComponent>

The components to display on the left side of the bar. Changes to this list will be respected until the bar is initialized.

centerComponents IList<BarComponent>

The components to display in the center of the bar. Changes to this list will be respected until the bar is initialized.

rightComponents IList<BarComponent>

The components to display on the right side of the bar. Changes to this list will be respected until the bar is initialized.

Remarks

The components lists can be changed up until when Whim is initialized.

Properties

Backdrop

The backdrop/material to use for the bar. Changes to this property during runtime will not be reflected in the UI - any changes must be done in the csx config prior to initializing Whim. Switching between different backdrops can influence the transparency - for more see BackdropType. Defaults to Mica, and to always show the backdrop.

public WindowBackdropConfig Backdrop { get; set; }

Property Value

WindowBackdropConfig

Remarks

To change the opacity for the bar's background color, make sure the hex color includes the alpha values.

CenterComponents

The components to display in the center of the bar. This will be set to the provided list, until the bar is initialized.

public IReadOnlyList<BarComponent> CenterComponents { get; }

Property Value

IReadOnlyList<BarComponent>

Height

The height of the bar, in device-independent pixels. Setting this explicitly takes precedence over the ResourceDictionary.

public int Height { get; set; }

Property Value

int

LeftComponents

The components to display in the center of the bar. This will be set to the provided list, until the bar is initialized.

public IReadOnlyList<BarComponent> LeftComponents { get; }

Property Value

IReadOnlyList<BarComponent>

RightComponents

The components to display in the center of the bar. This will be set to the provided list, until the bar is initialized.

public IReadOnlyList<BarComponent> RightComponents { get; }

Property Value

IReadOnlyList<BarComponent>

Methods

OnPropertyChanged(string)

Handler to call when a property changes.

protected virtual void OnPropertyChanged(string propertyName)

Parameters

propertyName string

The name of the property that changed.

Events

PropertyChanged

Occurs when a property value changes.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler