ThumbButtonInfo Class

  • Article

Represents information about how to display a button in the Windows 7 taskbar thumbnail.

Inheritance Hierarchy

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.DependencyObject
      System.Windows.Freezable
        Microsoft.Windows.Shell.ThumbButtonInfo

Namespace:  Microsoft.Windows.Shell
Assembly:  Microsoft.Windows.Shell (in Microsoft.Windows.Shell.dll)

Syntax

'Declaration
Public NotInheritable Class ThumbButtonInfo _
    Inherits Freezable _
    Implements ICommandSource

public sealed class ThumbButtonInfo : Freezable, 
    ICommandSource

public ref class ThumbButtonInfo sealed : public Freezable, 
    ICommandSource

[<Sealed>]
type ThumbButtonInfo =  
    class
        inherit Freezable
        interface ICommandSource
    end

public final class ThumbButtonInfo extends Freezable implements ICommandSource

The ThumbButtonInfo type exposes the following members.

Constructors

  Name Description
Public method ThumbButtonInfo Initializes a new instance of the ThumbButtonInfo class.

Top

Properties

  Name Description
Public property CanFreeze Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public property Command Gets or sets the command to invoke when this thumbnail button is clicked.
Public property CommandParameter Gets or sets the parameter to pass to the Command property.
Public property CommandTarget Gets or sets the element on which to raise the specified command.
Public property DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public property Description Gets or sets the text to display for the thumbnail button tooltip.
Public property DismissWhenClicked Gets or sets a value that indicates whether the taskbar thumbnail closes when the thumbnail button is clicked.
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property ImageSource Gets or sets the image that is displayed on the thumbnail button.
Public property IsBackgroundVisible Gets or sets a value that indicates whether a border and highlight is displayed around the thumbnail button.
Public property IsEnabled Gets or sets a value that indicates whether the thumbnail button is enabled.
Public property IsFrozen Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
Public property IsInteractive Gets or sets a value that indicates whether the user can interact with the thumbnail button.
Public property IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public property Visibility Gets or sets a value that specifies the display state of the thumbnail button.

Top

Methods

  Name Description
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public method ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public method Clone Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values. (Inherited from Freezable.)
Protected method CloneCore Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)
Public method CloneCurrentValue Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable.)
Protected method CloneCurrentValueCore Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable.)
Public method CoerceValue Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
Protected method CreateInstance Initializes a new instance of the Freezable class. (Inherited from Freezable.)
Protected method CreateInstanceCore When implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable.)
Public method Equals Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Freeze Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Protected method FreezeCore Makes the Freezable object unmodifiable or tests whether it can be made unmodifiable. (Inherited from Freezable.)
Public method GetAsFrozen Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
Protected method GetAsFrozenCore Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)
Public method GetCurrentValueAsFrozen Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
Protected method GetCurrentValueAsFrozenCore Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. (Inherited from Freezable.)
Public method GetHashCode Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public method GetLocalValueEnumerator Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public method InvalidateProperty Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnChanged Called when the current Freezable object is modified. (Inherited from Freezable.)
Protected method OnFreezablePropertyChanged(DependencyObject, DependencyObject) Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable.)
Protected method OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable.)
Protected method OnPropertyChanged Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable.)
Public method ReadLocalValue Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Protected method ReadPreamble Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable.)
Public method SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public method SetValue(DependencyPropertyKey, Object) Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Protected method ShouldSerializeProperty Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Protected method WritePostscript Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable.)
Protected method WritePreamble Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.)

Top

Events

  Name Description
Public event Changed Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
Public event Click Occurs when the thumbnail button is clicked.

Top

Fields

  Name Description
Public fieldStatic member CommandParameterProperty Identifies the CommandParameter dependency property.
Public fieldStatic member CommandProperty Identifies the Command dependency property.
Public fieldStatic member CommandTargetProperty Identifies the CommandTarget dependency property.
Public fieldStatic member DescriptionProperty Identifies the Description dependency property.
Public fieldStatic member DismissWhenClickedProperty Identifies the DismissWhenClicked dependency property.
Public fieldStatic member ImageSourceProperty Identifies the ImageSource dependency property.
Public fieldStatic member IsBackgroundVisibleProperty Identifies the IsBackgroundVisible dependency property.
Public fieldStatic member IsEnabledProperty Identifies the IsEnabled dependency property.
Public fieldStatic member IsInteractiveProperty Identifies the IsInteractive dependency property.
Public fieldStatic member VisibilityProperty Identifies the Visibility dependency property.

Top

Remarks

The Windows 7 taskbar provides enhanced functionality that enables you to use the taskbar button to communicate status to a user and expose common tasks when the window is minimized or hidden. You can add buttons to the taskbar thumbnail to provide access to common tasks without switching to the application window. For example, Windows Media Player provides Play, Pause, Forward, and Back buttons that you can use to control media playback from the taskbar thumbnail when the application is minimized.

The ThumbButtonInfo class contains properties that describe how the Windows 7 shell displays the buttons in the taskbar thumbnail. It provides a managed wrapper around the native Windows API. ThumbButtonInfo objects are contained in the TaskbarItemInfo.ThumbButtonInfos collection.

The enhanced taskbar functionality is not available in versions of Windows earlier than Windows 7. In Windows 7, some functionality might not be available depending on the user's settings. For example, buttons are only shown in the taskbar thumbnail when Windows Aero is enabled. Your application should provide alternate ways of interacting with the user that are not dependent on the enhanced taskbar functionality.

The following illustration shows a taskbar preview with two thumb buttons that provide access to the Play and Stop commands.

Windows Taskbar Thumb Buttons

Taskbar Item Info Sample

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Windows.Shell Namespace

TaskbarItemInfo