Class RadTaskbarButton

Inheritance
System.Object
RadTaskbarButton
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadTaskbarButton : Component, IThumbnailButtonOwner

Constructors

RadTaskbarButton()

Declaration
public RadTaskbarButton()

Fields

MaxThumbnailButtonsCount

The maximum number of thumbnail buttons that can be added to the taskbar button thumbnail toolbar. https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-itaskbarlist3-thumbbaraddbuttons

Declaration
public const int MaxThumbnailButtonsCount = 7
Field Value
System.Int32

Properties

ClipControl

Gets or sets the clip control of the thumbnail preview. Note that when this property is assigned the ClipRectangle property will be reset.

Declaration
public Control ClipControl { get; set; }
Property Value
System.Windows.Forms.Control

ClipRectangle

Gets or sets the clip rectangle of the thumbnail preview. Note that when this property is assigned the ClipControl property will be reset.

Declaration
public Rectangle ClipRectangle { get; set; }
Property Value
System.Drawing.Rectangle

OverlayIcon

Gets or sets the overlay icon used to be displayed over the taskbar button.

Declaration
public Bitmap OverlayIcon { get; set; }
Property Value
System.Drawing.Bitmap

OwnerForm

The form that is represented on the task bar.

Declaration
public Form OwnerForm { get; set; }
Property Value
System.Windows.Forms.Form

ProgressPercentage

Gets or sets the progress value displayed over the taskbar button in percents.

Declaration
public int ProgressPercentage { get; set; }
Property Value
System.Int32

ProgressState

Gets or sets the progress state displayed over the taskbar button.

Declaration
public TaskbarProgressState ProgressState { get; set; }
Property Value
TaskbarProgressState

Site

Declaration
public override ISite Site { get; set; }
Property Value
System.ComponentModel.ISite

ThumbnailButtons

Gets the thumbnail buttons collection. The thumbnail buttons represent a toolbar in the taskbar button flyout(located below the application image preview). If you have created the buttons at design time or before the System.Windows.Forms.Form.Shown event, this instance will automatically create the thumbnail toolbar and populate it with the already created buttons. After the System.Windows.Forms.Form.Shown event at runtime, to create the application thumbnail toolbar you need to explicitly call the AddThumbnailButtons() method. Note that after a toolbar has been added to a thumbnail, buttons can be altered only through UpdateThumbnailButtons(). While individual buttons cannot be added or removed, they can be shown and hidden through UpdateThumbnailButtons() as needed. The toolbar itself cannot be removed without re-creating the window itself.

Declaration
public ObservableCollection<RadThumbnailButton> ThumbnailButtons { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<RadThumbnailButton>

ThumbnailButtonsImageList

Gets or sets the ImageList that contains the images displayed by the thumbnail buttons.

Declaration
public ImageList ThumbnailButtonsImageList { get; set; }
Property Value
System.Windows.Forms.ImageList

Implements

ThumbnailTooltip

Gets or sets the thumbnail toltip text.

Declaration
public string ThumbnailTooltip { get; set; }
Property Value
System.String

Methods

AddThumbnailButtons()

Adds the ThumbnailButtons collection to the application toolbar. Note that once this method is executed and a toolbar has been added to a thumbnail, buttons can be altered only through UpdateThumbnailButtons(). While individual buttons cannot be added or removed, they can be shown and hidden through UpdateThumbnailButtons() as needed. The toolbar itself cannot be removed without re-creating the window itself.

Declaration
public virtual void AddThumbnailButtons()

CreateFilterWindow()

Declaration
protected virtual TaskbarFilterWindow CreateFilterWindow()
Returns
TaskbarFilterWindow

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Flash(Int32, Int32)

Flashes the form. It does not change the active state of the window.

Declaration
public void Flash(int count = 2147483647, int timeout = 0)
Parameters
System.Int32 count

Number of times that the taskbar button will flash. If you do not specify a value, the flashing is infinite, until the StopFlash() is executed.
System.Int32 timeout

The rate at which the window is to be flashed, in milliseconds. If timeout is zero, the function uses the default cursor blink rate.
Remarks

Typically, you flash a window to inform the user that the window requires attention but does not currently have the keyboard focus. When a window flashes, it appears to change from inactive to active status. An inactive caption bar changes to an active caption bar; an active caption bar changes to an inactive caption bar.

FlashUntilActive(Int32, Int32)

Flashes the specified window until it is activated. Note that if the window is currently active the flash will not begin.

Declaration
public void FlashUntilActive(int count = 2147483647, int timeout = 0)
Parameters
System.Int32 count

Number of times that the taskbar button will flash. If you do not specify a value the flashing is infinite or until the app is focused, until the StopFlash() is executed.
System.Int32 timeout

The rate at which the window is to be flashed, in milliseconds. If timeout is zero, the function uses the default cursor blink rate.

InitializeFields()

Declaration
protected virtual void InitializeFields()

OnThumbnailButtonChanged(RadThumbnailButton)

Updates the thumbnail button when changed.

Declaration
public virtual void OnThumbnailButtonChanged(RadThumbnailButton button)
Parameters
RadThumbnailButton button

Implements

OnThumbnailButtonClick(RadThumbnailButton)

Raises the thumbnail button click event.

Declaration
protected virtual void OnThumbnailButtonClick(RadThumbnailButton button)
Parameters
RadThumbnailButton button

SetOverlayIcon(Bitmap, String)

Sets the overlay icon of the taskbar button.

Declaration
public void SetOverlayIcon(Bitmap image, string accessibilityText = null)
Parameters
System.Drawing.Bitmap image

The overlay image.
System.String accessibilityText

The accessibility text.

SetProgressState(TaskbarProgressState)

Sets the progress state of the taskbar button.

Declaration
public void SetProgressState(TaskbarProgressState state)
Parameters
TaskbarProgressState state

The progress state.

SetProgressValue(Int32)

Sets the progress value of the taskbar button.

Declaration
public void SetProgressValue(int percent)
Parameters
System.Int32 percent

The progress value in percents.

SetProgressValue(Int32, Int32)

Sets the progress value of the taskbar button.

Declaration
public void SetProgressValue(int completed, int total)
Parameters
System.Int32 completed

The completed amount.
System.Int32 total

The total amount.

SetThumbnailClip(Rectangle)

Sets the clipping of the thumbnail preview.

Declaration
public void SetThumbnailClip(Rectangle clipRect)
Parameters
System.Drawing.Rectangle clipRect

The clip rectangle.

SetThumbnailClip(Control)

Sets the clipping of the thumbnail preview.

Declaration
public void SetThumbnailClip(Control clipControl)
Parameters
System.Windows.Forms.Control clipControl

The control that will be displayed in the clip rectangle.

SetThumbnialTooltip(String)

Sets the thumbnail toltip text.

Declaration
public void SetThumbnialTooltip(string thumbnailTooltip)
Parameters
System.String thumbnailTooltip

The tool tip text.

StopFlash()

Stops the flashing of the form.

Declaration
public void StopFlash()

UpdateAll()

Declaration
public virtual void UpdateAll()

UpdateThumbnailButtons()

Updates the thumbnail buttons after a change occurs in some of the buttons. Note that after a toolbar has been added to a thumbnail, buttons can be altered only through UpdateThumbnailButtons(). While individual buttons cannot be added or removed, they can be shown and hidden through UpdateThumbnailButtons() as needed. The toolbar itself cannot be removed without re-creating the window itself.

Declaration
public virtual void UpdateThumbnailButtons()

Events

ThumbnailButtonClick

Occurs when a RadThumbnailButton has been clicked.

Declaration
public event ThumbnailButtonEventHandler ThumbnailButtonClick
Event Type
ThumbnailButtonEventHandler

Extension Methods