Interface IUIInfoBar

A component that displays a bar aiming at indicating a relevant information to the user.

Inherited Members
Namespace: DevToys.Api
Assembly: DevToys.Api.dll
Syntax
public interface IUIInfoBar : IUIElement

Properties

ActionButtonText

Gets the text of the optional button to display in the bar. A null or empty value will hide the button. The bar closes when the user click on the button.

Declaration
string? ActionButtonText { get; }
Property Value
Type Description
string

Description

Gets the description to display in the bar.

Declaration
string? Description { get; }
Property Value
Type Description
string

IsActionButtonAccent

Gets whether the optional button to display in the bar should be accented. Default is false.

Declaration
bool IsActionButtonAccent { get; }
Property Value
Type Description
bool

IsClosable

Gets whether the bar can be closed by the user on demand. Default is true.

Declaration
bool IsClosable { get; }
Property Value
Type Description
bool

IsIconVisible

Gets whether the icon of the bar should be displayed or not. Default is true.

Declaration
bool IsIconVisible { get; }
Property Value
Type Description
bool

IsOpened

Gets whether the bar is opened. Default is false.

Declaration
bool IsOpened { get; }
Property Value
Type Description
bool

OnActionButtonClick

Gets the action to run when the user clicks the action button. The bar closes when the user click on the button.

Declaration
Func<ValueTask>? OnActionButtonClick { get; }
Property Value
Type Description
Func<ValueTask>

OnCloseAction

Gets the action to run when the user explicitly close the bar.

Declaration
Func<ValueTask>? OnCloseAction { get; }
Property Value
Type Description
Func<ValueTask>

Severity

Gets the severity of the information to display. Default is Informational.

Declaration
UIInfoBarSeverity Severity { get; }
Property Value
Type Description
UIInfoBarSeverity

Title

Gets the title to display in the bar.

Declaration
string? Title { get; }
Property Value
Type Description
string

Events

ActionButtonTextChanged

Raised when ActionButtonText is changed.

Declaration
event EventHandler? ActionButtonTextChanged
Event Type
Type Description
EventHandler

DescriptionChanged

Raised when Description is changed.

Declaration
event EventHandler? DescriptionChanged
Event Type
Type Description
EventHandler

IsActionButtonAccentChanged

Raised when IsActionButtonAccent is changed.

Declaration
event EventHandler? IsActionButtonAccentChanged
Event Type
Type Description
EventHandler

IsClosableChanged

Raised when IsClosable is changed.

Declaration
event EventHandler? IsClosableChanged
Event Type
Type Description
EventHandler

IsIconVisibleChanged

Raised when IsIconVisible is changed.

Declaration
event EventHandler? IsIconVisibleChanged
Event Type
Type Description
EventHandler

IsOpenedChanged

Raised when IsOpened is changed.

Declaration
event EventHandler? IsOpenedChanged
Event Type
Type Description
EventHandler

OnActionButtonClickChanged

Raised when OnActionButtonClick is changed.

Declaration
event EventHandler? OnActionButtonClickChanged
Event Type
Type Description
EventHandler

OnCloseActionChanged

Raised when OnCloseAction is changed.

Declaration
event EventHandler? OnCloseActionChanged
Event Type
Type Description
EventHandler

SeverityChanged

Raised when Severity is changed.

Declaration
event EventHandler? SeverityChanged
Event Type
Type Description
EventHandler

TitleChanged

Raised when Title is changed.

Declaration
event EventHandler? TitleChanged
Event Type
Type Description
EventHandler

Extension Methods