C# Class Support.UI.WaitDialog

Inheritance: System.Windows.Forms.Form

Public Methods

Method	Description
CloseWaitDialog ( ) : void	Used in place of the Close method to avoid threading issues
ProgressGet ( int nProgressBar ) : int	Gets the value of the specified progress bar.
ProgressReset ( int nProgressBar, int nMin, int nMax, int nStartVal ) : void	Resets the specified progress bar.
ProgressSet ( int nProgressBar, int nValue ) : void	Sets the value on the specified progress bar.
ProgressStep ( int nProgressBar ) : void	Steps the value on the specified progress bar.
SetStatusText ( string sText ) : void	Sets the status text
WaitDialog ( int nProgressBarCount, ParameterizedThreadStart zThreadStart, object zParamObject, string sTitle, string arrayDescriptions, int nWidth ) : System	Creates a new WaitDialog with the specified ThreadStart.
WaitDialog ( int nProgressBarCount, ThreadStart zThreadStart, string sTitle, string arrayDescriptions, int nWidth ) : System	Creates a new WaitDialog with the specified ThreadStart.

Method	Description
AddProgressBars ( int nProgressBarCount ) : void	Adds the specified number of progress bars to the WaitDialog. Also configures the other Controls in the window.
Initialize ( int nProgressBarCount, string sTitle, string arrayDescriptions, int nWidth ) : void	Sets up the basic controls
WaitDialog_Load ( object sender, EventArgs e ) : void	When the dialog is shown the associated thread is started.
btnCancel_Click ( object sender, EventArgs e ) : void	Cancels the associated thread. (returns from Show/ShowDialog)

Used in place of the Close method to avoid threading issues

public CloseWaitDialog ( ) : void
return	void

Gets the value of the specified progress bar.

public ProgressGet ( int nProgressBar ) : int
nProgressBar	int	The progress bar to get (0 based)
return	int

Resets the specified progress bar.

public ProgressReset ( int nProgressBar, int nMin, int nMax, int nStartVal ) : void
nProgressBar	int	The progress bar to reset (0 based)
nMin	int	The minimum value to set on the progress bar
nMax	int	The maximum value to set on the progress bar
nStartVal	int	The starting value to set on the progress bar
return	void

Sets the value on the specified progress bar.

public ProgressSet ( int nProgressBar, int nValue ) : void
nProgressBar	int	The progress bar to set (0 based)
nValue	int	The value to set
return	void

Steps the value on the specified progress bar.

public ProgressStep ( int nProgressBar ) : void
nProgressBar	int	The progress bar to step (0 based)
return	void

Sets the status text

public SetStatusText ( string sText ) : void
sText	string
return	void

Creates a new WaitDialog with the specified ThreadStart.

public WaitDialog ( int nProgressBarCount, ParameterizedThreadStart zThreadStart, object zParamObject, string sTitle, string arrayDescriptions, int nWidth ) : System
nProgressBarCount	int	The number of progress bars to include.
zThreadStart	ParameterizedThreadStart	The ThreadStart to initialize
zParamObject	object	The object to pass to the thread method
sTitle	string	The title of the wait dialog
arrayDescriptions	string	Optional array of strings for each progress bar. (null is allowed)
nWidth	int	Desired width of the WaitDialog, must be >100
return	System

Creates a new WaitDialog with the specified ThreadStart.

public WaitDialog ( int nProgressBarCount, ThreadStart zThreadStart, string sTitle, string arrayDescriptions, int nWidth ) : System
nProgressBarCount	int	The number of progress bars to include.
zThreadStart	ThreadStart	The ThreadStart to initialize
sTitle	string	The title of the wait dialog
arrayDescriptions	string	Optional array of strings for each progress bar. (null is allowed)
nWidth	int	Desired width of the WaitDialog, must be >100
return	System