TrayIcon Class

Definition

Namespace:Avalonia.Controls

Assembly:Avalonia.Controls

Package:Avalonia

Source:TrayIcon.cs

public class TrayIcon

Inheritance: object -> AvaloniaObject -> TrayIcon

Implements: INativeMenuExporterProvider, IDisposable

Constructors

Name	Description
TrayIcon	No summary available.

TrayIcon Constructor

public TrayIcon()

Methods

Name	Description
Bind (8 overloads)	Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccess	Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)	Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValue	Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
Dispose	Disposes the tray icon (removing it from the tray area).
Equals	Compares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValue	Inherited from AvaloniaObject.
GetHashCode	Gets the hash code for the object. Inherited from AvaloniaObject.
GetIcons	No summary available.
GetValue (3 overloads)	Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimating	Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSet	Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
SetCurrentValue (2 overloads)	Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetIcons	No summary available.
SetValue (3 overloads)	Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
VerifyAccess	Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

Dispose Method

Disposes the tray icon (removing it from the tray area).

public void Dispose()

GetIcons Method

public Avalonia.Controls.TrayIcons GetIcons(Avalonia.Application o)

Parameters

o Avalonia.Application

Returns

Avalonia.Controls.TrayIcons

SetIcons Method

public void SetIcons(Avalonia.Application o, Avalonia.Controls.TrayIcons trayIcons)

Parameters

o Avalonia.Application

trayIcons Avalonia.Controls.TrayIcons

Properties

Name	Description
Command	Gets or sets the Avalonia.Controls.TrayIcon.Command property of a TrayIcon.
CommandParameter	Gets or sets the parameter to pass to the Avalonia.Controls.TrayIcon.Command property of a Avalonia.Controls.TrayIcon.
Dispatcher	Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
Icon	Gets or sets the icon of the TrayIcon.
IsVisible	Gets or sets the visibility of the TrayIcon.
Item	Inherited from AvaloniaObject.
Menu	Gets or sets the Menu of the TrayIcon.
NativeMenuExporter	No summary available.
ToolTipText	Gets or sets the tooltip text of the TrayIcon.

Command Property

Gets or sets the Avalonia.Controls.TrayIcon.Command property of a TrayIcon.

public System.Windows.Input.ICommand Command { get; set; }

CommandParameter Property

Gets or sets the parameter to pass to the Avalonia.Controls.TrayIcon.Command property of a Avalonia.Controls.TrayIcon.

public object CommandParameter { get; set; }

Icon Property

Gets or sets the icon of the TrayIcon.

public Avalonia.Controls.WindowIcon Icon { get; set; }

IsVisible Property

Gets or sets the visibility of the TrayIcon.

public bool IsVisible { get; set; }

Menu Property

Gets or sets the Menu of the TrayIcon.

public Avalonia.Controls.NativeMenu Menu { get; set; }

NativeMenuExporter Property

public Avalonia.Controls.Platform.INativeMenuExporter NativeMenuExporter { get; set; }

ToolTipText Property

Gets or sets the tooltip text of the TrayIcon.

public string ToolTipText { get; set; }

Fields

Name	Description
CommandParameterProperty	Defines the Avalonia.Controls.TrayIcon.CommandParameter property.
CommandProperty	Defines the Avalonia.Controls.TrayIcon.Command property.
IconProperty	Defines the Avalonia.Controls.TrayIcon.Icon property.
IconsProperty	Defines the Avalonia.Controls.TrayIcons attached property.
IsVisibleProperty	Defines the Avalonia.Controls.TrayIcon.IsVisible property.
MenuProperty	Defines the Avalonia.Controls.TrayIcon.Menu property.
ToolTipTextProperty	Defines the Avalonia.Controls.TrayIcon.ToolTipText property.

CommandParameterProperty Field

Defines the Avalonia.Controls.TrayIcon.CommandParameter property.

public Avalonia.StyledProperty<object> CommandParameterProperty

CommandProperty Field

Defines the Avalonia.Controls.TrayIcon.Command property.

public Avalonia.StyledProperty<System.Windows.Input.ICommand> CommandProperty

IconProperty Field

Defines the Avalonia.Controls.TrayIcon.Icon property.

public Avalonia.StyledProperty<Avalonia.Controls.WindowIcon> IconProperty

IconsProperty Field

Defines the Avalonia.Controls.TrayIcons attached property.

public Avalonia.AttachedProperty<Avalonia.Controls.TrayIcons> IconsProperty

IsVisibleProperty Field

Defines the Avalonia.Controls.TrayIcon.IsVisible property.

public Avalonia.StyledProperty<bool> IsVisibleProperty

MenuProperty Field

Defines the Avalonia.Controls.TrayIcon.Menu property.

public Avalonia.StyledProperty<Avalonia.Controls.NativeMenu> MenuProperty

ToolTipTextProperty Field

Defines the Avalonia.Controls.TrayIcon.ToolTipText property.

public Avalonia.StyledProperty<string> ToolTipTextProperty

Events

Name	Description
Clicked	Raised when the TrayIcon is clicked. Note, this is only supported on Win32 and some Linux DEs, on OSX this event is not raised.
PropertyChanged	Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.

Clicked Event

Raised when the TrayIcon is clicked. Note, this is only supported on Win32 and some Linux DEs, on OSX this event is not raised.

public event EventHandler Clicked