Class ThumbnailToolBarButton

Namespace

Microsoft.WindowsAPICodePack.Taskbar

Assembly

Microsoft.WindowsAPICodePack.Shell.dll

Represents a taskbar thumbnail button in the thumbnail toolbar.

public sealed class ThumbnailToolBarButton : IDisposable

Inheritance

object

ThumbnailToolBarButton

Implements

IDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ThumbnailToolBarButton(Icon, string)

Initializes an instance of this class

public ThumbnailToolBarButton(Icon icon, string tooltip)

Parameters

icon Icon

The icon to use for this button

tooltip string

The tooltip string to use for this button.

Properties

DismissOnClick

Gets or sets the property that describes the behavior when the button is clicked. If set to true, the taskbar button's flyout will close immediately. Default is false.

public bool DismissOnClick { get; set; }

Property Value

bool

Enabled

Gets or sets the thumbnail button's enabled state. If the button is disabled, it is present, but has a visual state that indicates that it will not respond to user action. Default is true.

public bool Enabled { get; set; }

Property Value

bool

Icon

Gets or sets the thumbnail button's icon.

public Icon Icon { get; set; }

Property Value

Icon

IsInteractive

Gets or sets the property that describes whether the button is interactive with the user. Default is true.

public bool IsInteractive { get; set; }

Property Value

bool

Remarks

Non-interactive buttons don't display any hover behavior nor do they raise click events. They are intended to be used as status icons. This is mostly similar to being not Enabled, but the image is not desaturated.

Tooltip

Gets or sets the thumbnail button's tooltip.

public string Tooltip { get; set; }

Property Value

string

Visible

Gets or sets the thumbnail button's visibility. Default is true.

public bool Visible { get; set; }

Property Value

bool

Methods

Dispose()

Release the native objects.

public void Dispose()

Dispose(bool)

Release the native objects.

public void Dispose(bool disposing)

Parameters

disposing bool

~ThumbnailToolBarButton()

protected ~ThumbnailToolBarButton()

Events

Click

The event that occurs when the taskbar thumbnail button is clicked.

public event EventHandler<ThumbnailButtonClickedEventArgs> Click

Event Type

EventHandler<ThumbnailButtonClickedEventArgs>