Documentation

Class RadTaskbarManager

Inheritance
System.Object
RadTaskbarManager
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadTaskbarManager

Constructors

RadTaskbarManager()

Declaration
public RadTaskbarManager()

Methods

ActivateTab(IntPtr)

Activates an item on the taskbar. The window is not actually activated; the window's item on the taskbar is merely displayed as active.

Declaration
public static void ActivateTab(IntPtr formHandle)
Parameters
System.IntPtr formHandle

A handle to the window on the taskbar to be displayed as active.

AddTab(IntPtr)

Adds an item to the taskbar.

Declaration
public static void AddTab(IntPtr formHandle)
Parameters
System.IntPtr formHandle

A handle to the window to be added to the taskbar.

DeleteTab(IntPtr)

Deletes an item from the taskbar.

Declaration
public static void DeleteTab(IntPtr formHandle)
Parameters
System.IntPtr formHandle

A handle to the window to be deleted from the taskbar.

Flash(IntPtr, Int32, Int32)

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

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

A handle to the window to be flashed. The window can be either opened or minimized.
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(IntPtr) 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.

FlashCore(IntPtr, FLASHINFOFLAGS, Int32, Int32)

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

Declaration
public static void FlashCore(IntPtr formHandle, FLASHINFOFLAGS flags, int count = 0, int timeout = 0)
Parameters
System.IntPtr formHandle

A handle to the window to be flashed. The window can be either opened or minimized.
FLASHINFOFLAGS flags

The flash status. This parameter can be one or more of the FLASHINFOFLAGS enum values.
System.Int32 count

The number of times to flash the window.
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.

FlashUntilActive(IntPtr, 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 static void FlashUntilActive(IntPtr formHandle, int count = 0, int timeout = 0)
Parameters
System.IntPtr formHandle

A handle to the window to be flashed. The window can be either opened or minimized.
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(IntPtr) 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.

MarkFullscreenWindow(IntPtr, Boolean)

Marks a window as full-screen.

Declaration
public static void MarkFullscreenWindow(IntPtr formHandle, bool fullScreen)
Parameters
System.IntPtr formHandle

The handle of the window to be marked.
System.Boolean fullScreen

A Boolean value marking the desired full-screen status of the window.

RegisterTab(IntPtr, IntPtr)

Informs the taskbar that a new tab or document thumbnail has been provided for display in an application's taskbar group flyout.

Declaration
public static void RegisterTab(IntPtr tabHandle, IntPtr handleMdi)
Parameters
System.IntPtr tabHandle

Handle of the tab or document window. This value is required and cannot be System.IntPtr.Zero.
System.IntPtr handleMdi

Handle of the application's main window. This value tells the taskbar which application's preview group to attach the new thumbnail to. This value is required and cannot be System.IntPtr.Zero.

SetActiveAlt(IntPtr)

Marks a taskbar item as active but does not visually activate it.

Declaration
public static void SetActiveAlt(IntPtr formHandle)
Parameters
System.IntPtr formHandle

A handle to the window to be marked as active.

SetOverlayIcon(IntPtr, Bitmap, String)

Applies an overlay to a taskbar button to indicate application status or a notification to the user.

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

The handle of the window whose associated taskbar button receives the overlay. This handle must belong to a calling process associated with the button's application and must be a valid HWND or the call is ignored.
System.Drawing.Bitmap image

The overlay image.
System.String accessibilityText

A string that provides an alt text version of the information conveyed by the overlay, for accessibility purposes.

SetOverlayIcon(IntPtr, IntPtr, String)

Applies an overlay to a taskbar button to indicate application status or a notification to the user.

Declaration
public static void SetOverlayIcon(IntPtr formHandle, IntPtr hIcon, string accessibilityText = null)
Parameters
System.IntPtr formHandle

The handle of the window whose associated taskbar button receives the overlay. This handle must belong to a calling process associated with the button's application and must be a valid HWND or the call is ignored.
System.IntPtr hIcon

The handle of an icon to use as the overlay. This should be a small icon, measuring 16x16 pixels at 96 dpi. If an overlay icon is already applied to the taskbar button, that existing overlay is replaced. This value can be System.IntPtr.Zero. How a System.IntPtr.Zero value is handled depends on whether the taskbar button represents a single window or a group of windows. If the taskbar button represents a single window, the overlay icon is removed from the display. If the taskbar button represents a group of windows and a previous overlay is still available (received earlier than the current overlay, but not yet freed by a NULL value), then that previous overlay is displayed in place of the current overlay. It is the responsibility of the calling application to free hIcon when it is no longer needed. This can generally be done after you call SetOverlayIcon because the taskbar makes and uses its own copy of the icon.
System.String accessibilityText

A string that provides an alt text version of the information conveyed by the overlay, for accessibility purposes.

SetProgressState(IntPtr, TaskbarProgressState)

Sets the type and state of the progress indicator displayed on a taskbar button.

Declaration
public static void SetProgressState(IntPtr formHandle, TaskbarProgressState state)
Parameters
System.IntPtr formHandle

The handle of the window in which the progress of an operation is being shown. This window's associated taskbar button will display the progress bar.
TaskbarProgressState state

Flags that control the current state of the progress button. Specify only one of the following flags TaskbarProgressState; all states are mutually exclusive of all others.

SetProgressValue(IntPtr, Int32)

Displays or updates a progress bar hosted in a taskbar button to show the specific percentage completed of the full operation.

Declaration
public static void SetProgressValue(IntPtr formHandle, int percent)
Parameters
System.IntPtr formHandle

The handle of the window whose associated taskbar button is being used as a progress indicator.
System.Int32 percent

An application-defined value that specifies percentage of the ongoing operation completion.

SetProgressValue(IntPtr, Int32, Int32)

Displays or updates a progress bar hosted in a taskbar button to show the specific percentage completed of the full operation.

Declaration
public static void SetProgressValue(IntPtr formHandle, int completed, int total)
Parameters
System.IntPtr formHandle

The handle of the window whose associated taskbar button is being used as a progress indicator.
System.Int32 completed

An application-defined value that indicates the proportion of the operation that has been completed at the time the method is called.
System.Int32 total

An application-defined value that specifies the value completed will have when the operation is complete.

SetTabActive(IntPtr, IntPtr)

Informs the taskbar that a tab or document window has been made the active window.

Declaration
public static void SetTabActive(IntPtr tabHandle, IntPtr handleMdi)
Parameters
System.IntPtr tabHandle

Handle of the active tab window. This handle must already be registered through RegisterTab(IntPtr, IntPtr). This value can be System.IntPtr.Zero if no tab is active.
System.IntPtr handleMdi

Handle of the application's main window. This value tells the taskbar which group the thumbnail is a member of. This value is required and cannot be System.IntPtr.Zero.

SetTabOrder(IntPtr, IntPtr)

Inserts a new thumbnail into a tabbed-document interface (TDI) or multiple-document interface (MDI) application's group flyout or moves an existing thumbnail to a new position in the application's group.

Declaration
public static void SetTabOrder(IntPtr tabHandle, IntPtr insertBeforeHandle)
Parameters
System.IntPtr tabHandle

The handle of the tab window whose thumbnail is being placed. This value is required, must already be registered through RegisterTab(IntPtr, IntPtr), and cannot be System.IntPtr.Zero.
System.IntPtr insertBeforeHandle

The handle of the tab window whose thumbnail that tabHandle is inserted to the left of. This handle must already be registered through RegisterTab(IntPtr, IntPtr). If this value is System.IntPtr.Zero, the new thumbnail is added to the end of the list.

SetTabProperties(IntPtr, SetTabPropertiesOption)

Allows a tab to specify whether the main application frame window or the tab window should be used as a thumbnail or in the peek feature under certain circumstances.

Declaration
public static void SetTabProperties(IntPtr tabHandle, SetTabPropertiesOption option)
Parameters
System.IntPtr tabHandle

The handle of the tab window that is to have properties set. This handle must already be registered through RegisterTab(IntPtr, IntPtr).
SetTabPropertiesOption option

One or more members of the SetTabPropertiesOption enumeration that specify the displayed thumbnail and peek image source of the tab thumbnail.

SetThumbnailClip(IntPtr, RefRECT)

Selects a portion of a window's client area to display as that window's thumbnail in the taskbar.

Declaration
public static void SetThumbnailClip(IntPtr formHandle, RefRECT clipRect)
Parameters
System.IntPtr formHandle

The handle to a window represented in the taskbar.
RefRECT clipRect

A RefRECT structure that specifies a selection within the window's client area, relative to the upper-left corner of that client area. To clear a clip that is already in place and return to the default display of the thumbnail, set this parameter to NULL.

SetThumbnailClip(Form, Rectangle)

Selects a portion of a window's client area to display as that window's thumbnail in the taskbar.

Declaration
public static void SetThumbnailClip(Form form, Rectangle clipRect)
Parameters
System.Windows.Forms.Form form

The form represented in the taskbar.
System.Drawing.Rectangle clipRect

The clip rectangle. To clear a clip that is already in place and return to the default display of the thumbnail, set this parameter to System.Drawing.Rectangle.Empty.

SetThumbnailClip(Form, Control)

Selects a portion of a window's client area to display as that window's thumbnail in the taskbar.

Declaration
public static void SetThumbnailClip(Form form, Control clipControl)
Parameters
System.Windows.Forms.Form form

The form represented in the taskbar.
System.Windows.Forms.Control clipControl

The control that will be displayed in the clip rectangle. To clear a clip that is already in place and return to the default display of the thumbnail, set this parameter to NULL.

SetThumbnailTooltip(IntPtr, String)

Specifies or updates the text of the tooltip that is displayed when the mouse pointer rests on an individual preview thumbnail in a taskbar button flyout.

Declaration
public static void SetThumbnailTooltip(IntPtr formHandle, string toolTip)
Parameters
System.IntPtr formHandle

The handle to the window whose thumbnail displays the tooltip. This handle must belong to the calling process.
System.String toolTip

The text to be displayed in the tooltip. This value can be NULL, in which case the title of the window specified by hwnd is used as the tooltip.

StopFlash(IntPtr)

Stops the flashing of the specified window.

Declaration
public static void StopFlash(IntPtr formHandle)
Parameters
System.IntPtr formHandle

A handle to the window that is currently flashing.

ThumbBarSetImageList(IntPtr, IntPtr)

Specifies an image list that contains button images for a toolbar embedded in a thumbnail image of a window in a taskbar button flyout.

Declaration
public static void ThumbBarSetImageList(IntPtr formHandle, IntPtr imagelistHandle)
Parameters
System.IntPtr formHandle

The handle of the window whose thumbnail representation contains the toolbar to be updated. This handle must belong to the calling process.
System.IntPtr imagelistHandle

The handle of the image list that contains all button images to be used in the toolbar.

UnregisterTab(IntPtr)

Removes a thumbnail from an application's preview group when that tab or document is closed in the application.

Declaration
public static void UnregisterTab(IntPtr tabHandle)
Parameters
System.IntPtr tabHandle

The handle of the tab window whose thumbnail is being removed. This is the same value with which the thumbnail was registered as part the group through RegisterTab(IntPtr, IntPtr). This value is required and cannot be System.IntPtr.Zero.

Extension Methods