C# Class XCore.XMessageBoxExManager

a subclass of the (open-source) message box manager which interfaces it to XCore

Inheritance: Utils.MessageBoxExLib.MessageBoxExManager

Datei anzeigen Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property	Type	Description
s_singletonMessageBoxExManager	XMessageBoxExManager>.Dictionary

Public Methods

Method	Description
CheckDisposed ( ) : void	Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
DefineMessageBox ( string triggerName, string caption, string text, bool displayDontShowAgainButton, string iconName ) : void
Dispose ( ) : void	Must not be virtual.
ReadSettingsFile ( ) : void	load with properties stored in the settings file, if that file is found.
Trigger ( string triggerName ) : string
WriteSavedResponses ( ) : void

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed. If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.
GetIcon ( string name ) : System.Drawing.Icon

Private Methods

Method	Description
AddSavedResponsesSafely ( string>.Dictionary responseDict, StringPair pair ) : void
CreateXMessageBoxExManager ( string appName ) : XMessageBoxExManager
MakeArrayForSerializing ( ) : XCore.StringPair[]
ReadStringPairArrayForDeserializing ( StringPair list ) : void
SettingsPath ( ) : string
XMessageBoxExManager ( string appName ) : System	only the factory method can make one of these

Method Details

CheckDisposed() public method

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

public CheckDisposed ( ) : void
return	void

DefineMessageBox() public method

public DefineMessageBox ( string triggerName, string caption, string text, bool displayDontShowAgainButton, string iconName ) : void
triggerName	string
caption	string
text	string
displayDontShowAgainButton	bool
iconName	string
return	void

Dispose() public method

Must not be virtual.

public Dispose ( ) : void
return	void

Dispose() protected method

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

GetIcon() protected method

protected GetIcon ( string name ) : System.Drawing.Icon
name	string
return	System.Drawing.Icon

ReadSettingsFile() public method

load with properties stored in the settings file, if that file is found.

public ReadSettingsFile ( ) : void
return	void

Trigger() static public method

static public Trigger ( string triggerName ) : string
triggerName	string
return	string

WriteSavedResponses() public method

public WriteSavedResponses ( ) : void
return	void

Property Details

s_singletonMessageBoxExManager protected_oe static_oe property

protected static Dictionary s_singletonMessageBoxExManager
return	XMessageBoxExManager>.Dictionary