Class StatusBarHelper - Markdown Monster Documentation

Class StatusBarHelper

A Status bar helper class that provides methods like ShowStatusSuccess, ShowStatusError, ShowStatusWarning to display messages on an existing status bar. This helper maps statusbar text and icon controls and sets their properties deterministically.

For icons this helper uses the Wpf.FontAwesome library which is a dependency

System.Object
MarkdownMonster.Windows.StatusBarHelper

public class StatusBarHelper : object

Class Members

Member		Description
	Constructor
	FlashIcon	Flashes the icon briefly public void FlashIcon(FontAwesome icon)
	SetStatusIcon	Status the statusbar icon on the left bottom to some indicator public void SetStatusIcon(FontAwesomeIcon icon, Color color, bool spin) public void SetStatusIcon()
	ShowStatus	public void ShowStatus(string message, int milliSeconds, FontAwesomeIcon icon, Color color, bool spin, bool noDispatcher) public void ShowStatus(string message, int milliSeconds, FontAwesomeIcon icon, Color color, bool spin, bool noDispatcher, bool flashIcon)
	ShowStatusError	Displays an error message using common defaults for a timeout milliseconds public void ShowStatusError(string message, int timeout, FontAwesomeIcon icon, Color color) public void ShowStatusError(string message, int timeout, FontAwesomeIcon icon, Color color, bool flashIcon)
	ShowStatusProgress	Displays an Progress message using common defaults including a spinning icon public void ShowStatusProgress(string message, int timeout, FontAwesomeIcon icon, Color color, bool spin)
	ShowStatusSuccess	Shows a success message with a green check icon for the timeout public void ShowStatusSuccess(string message, int timeout, FontAwesomeIcon icon, Color color) public void ShowStatusSuccess(string message, int timeout, FontAwesomeIcon icon, Color color, bool flashIcon)
	DefaultIconColor	The Default color that's used when the timeout is up and reverts to a default state.
	DefaultStatusIcon	The default icon that the control reverts to after the DefaultTimeout is up
	DefaultStatusText	The default status text that the control reverts to after the DefaultTimeout is up.
	DefaultTimeoutMs	The default timeout that's used when the timeout is passed in as -1 which is the default. This will set teh default display of the
	IconAnimationTime
	StatusIconControl	Optional FontAwesome Icon control that gets set if a specific icon is requested. The icon is reset to its default icon
	StatusTextControl	This is the status text control that receives text messages and is updated when values are applied.

Requirements

Namespace: MarkdownMonster.Windows
Assembly: markdownmonster.exe