C# Class Microsoft.WindowsAPICodePack.Taskbar.TaskbarManager

Represents an instance of the Windows taskbar

Mostra file Open project: dlech/SshAgentLib Class Usage Examples

Private Properties

Property	Type	Description
GetCurrentProcessAppId	string
SetCurrentProcessAppId	void
TaskbarManager	System

Public Methods

Method	Description
SetApplicationIdForSpecificWindow ( IntPtr windowHandle, string appId ) : void	Sets the application user model id for an individual window AppId specifies a unique Application User Model ID (AppID) for the application or individual top-level window whose taskbar button will hold the custom JumpList built through the methods Microsoft.WindowsAPICodePack.Taskbar.JumpList class. By setting an appId for a specific window, the window will not be grouped with it's parent window/application. Instead it will have it's own taskbar button.
SetOverlayIcon ( IntPtr windowHandle, System icon, string accessibilityText ) : void	Applies an overlay to a taskbar button of the given window handle to indicate application status or a notification to the user.
SetOverlayIcon ( System icon, string accessibilityText ) : void	Applies an overlay to a taskbar button of the main application window to indicate application status or a notification to the user.
SetProgressState ( TaskbarProgressBarState state ) : void	/// Displays or updates a progress bar hosted in a taskbar button of the given WPF window /// to show the specific percentage completed of the full operation. /// Sets the type and state of the progress indicator displayed on a taskbar button of the main application window.
SetProgressState ( TaskbarProgressBarState state, IntPtr windowHandle ) : void	Sets the type and state of the progress indicator displayed on a taskbar button of the given window handle
SetProgressValue ( int currentValue, int maximumValue ) : void	/// Applies an overlay to a taskbar button of the given WPF window to indicate application status or a notification to the user. /// Displays or updates a progress bar hosted in a taskbar button of the main application window to show the specific percentage completed of the full operation.
SetProgressValue ( int currentValue, int maximumValue, IntPtr windowHandle ) : void	Displays or updates a progress bar hosted in a taskbar button of the given window handle to show the specific percentage completed of the full operation.

Private Methods

Method	Description
GetCurrentProcessAppId ( ) : string	Gets the current process' explicit application user model id.
SetCurrentProcessAppId ( string appId ) : void	/// Sets the application user model id for a given window /// Sets the current process' explicit application user model id. AppId specifies a unique Application User Model ID (AppID) for the application or individual /// top-level window whose taskbar button will hold the custom JumpList built through the methods Microsoft.WindowsAPICodePack.Taskbar.JumpList class. /// By setting an appId for a specific window, the window will not be grouped with it's parent window/application. Instead it will have it's own taskbar button.
TaskbarManager ( ) : System

Method Details

SetApplicationIdForSpecificWindow() public method

Sets the application user model id for an individual window

AppId specifies a unique Application User Model ID (AppID) for the application or individual top-level window whose taskbar button will hold the custom JumpList built through the methods Microsoft.WindowsAPICodePack.Taskbar.JumpList class. By setting an appId for a specific window, the window will not be grouped with it's parent window/application. Instead it will have it's own taskbar button.

public SetApplicationIdForSpecificWindow ( IntPtr windowHandle, string appId ) : void
windowHandle	System.IntPtr	Window handle for the window that needs a specific application id
appId	string	The app id to set
return	void

SetOverlayIcon() public method

Applies an overlay to a taskbar button of the given window handle to indicate application status or a notification to the user.

public SetOverlayIcon ( IntPtr windowHandle, System icon, string accessibilityText ) : void
windowHandle	System.IntPtr	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.
icon	System	The overlay icon
accessibilityText	string	String that provides an alt text version of the information conveyed by the overlay, for accessibility purposes
return	void

SetOverlayIcon() public method

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

public SetOverlayIcon ( System icon, string accessibilityText ) : void
icon	System	The overlay icon
accessibilityText	string	String that provides an alt text version of the information conveyed by the overlay, for accessibility purposes
return	void

SetProgressState() public method

/// Displays or updates a progress bar hosted in a taskbar button of the given WPF window /// to show the specific percentage completed of the full operation. /// Sets the type and state of the progress indicator displayed on a taskbar button of the main application window.

public SetProgressState ( TaskbarProgressBarState state ) : void
state	TaskbarProgressBarState	Progress state of the progress button
return	void

SetProgressState() public method

Sets the type and state of the progress indicator displayed on a taskbar button of the given window handle

public SetProgressState ( TaskbarProgressBarState state, IntPtr windowHandle ) : void
state	TaskbarProgressBarState	Progress state of the progress button
windowHandle	System.IntPtr	The handle of the window whose associated taskbar button is being used as a progress indicator. /// This window belong to a calling process associated with the button's application and must be already loaded.
return	void

SetProgressValue() public method

/// Applies an overlay to a taskbar button of the given WPF window to indicate application status or a notification to the user. /// Displays or updates a progress bar hosted in a taskbar button of the main application window to show the specific percentage completed of the full operation.

public SetProgressValue ( int currentValue, int maximumValue ) : void
currentValue	int	An application-defined value that indicates the proportion of the operation that has been completed at the time the method is called.
maximumValue	int	An application-defined value that specifies the value currentValue will have when the operation is complete.
return	void

SetProgressValue() public method

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

public SetProgressValue ( int currentValue, int maximumValue, IntPtr windowHandle ) : void
currentValue	int	An application-defined value that indicates the proportion of the operation that has been completed at the time the method is called.
maximumValue	int	An application-defined value that specifies the value currentValue will have when the operation is complete.
windowHandle	System.IntPtr	The handle of the window whose associated taskbar button is being used as a progress indicator. /// This window belong to a calling process associated with the button's application and must be already loaded.
return	void