C# Class SIP_Agent.Helper.UI

Common helper functions for managing the UI

Public Properties

Method	Description
CmbIndexByValue ( ComboBox combo, int s ) : int	Searches combobox items by their value
TodayDate ( System.DateTime Date ) : string	Returns a short DateString if the input date is today, long DateString otherwise
flash ( object sender, System.Windows.Media.Brush color = null, int duration = 4000 ) : void	Flash an UI element to give visual feedback on action result. An example would be flashing the Save button red after an unsuccessful save.
timer_Elapsed ( object sender, System.Timers.ElapsedEventArgs e ) : void	Called when the flashing timer activates. Resets the background,

Searches combobox items by their value

public static CmbIndexByValue ( ComboBox combo, int s ) : int
combo	System.Windows.Controls.ComboBox	Reference to to combobox (SetValuePath)
s	int	Searched value
return	int

Returns a short DateString if the input date is today, long DateString otherwise

public static TodayDate ( System.DateTime Date ) : string
Date	System.DateTime
return	string

Flash an UI element to give visual feedback on action result. An example would be flashing the Save button red after an unsuccessful save.

public static flash ( object sender, System.Windows.Media.Brush color = null, int duration = 4000 ) : void
sender	object	The target object (button)
color	System.Windows.Media.Brush	The Brush to paint the object with
duration	int	How long to flash
return	void

Called when the flashing timer activates. Resets the background,

public static timer_Elapsed ( object sender, System.Timers.ElapsedEventArgs e ) : void
sender	object
e	System.Timers.ElapsedEventArgs
return	void

The brush used when painting objects on errors

public static Brush,System.Windows.Media ERROR_BRUSH
return	System.Windows.Media.Brush

The brush used when painting objects on success

public static Brush,System.Windows.Media SUCCESS_BRUSH
return	System.Windows.Media.Brush

Stores the original background of a flashing object

public static Brush,System.Windows.Media flashBackground
return	System.Windows.Media.Brush

Stores the object awaiting flash cancellation

public static object flashObject
return	object