C# Class FdoToolbox.Base.Forms.ProgressDialog

Generic progress dialog

Inheritance: System.Windows.Forms.Form

Public Properties

Property	Type	Description
actionBaseText	string
actionText	string

Method	Description
SetMax ( int max ) : void	Sets the maximum value. If the maximum is less than or equal to 0, then the progress animation will become marquee.
SetMessage ( string message ) : void	Sets the message of the progress dialog
SetTitle ( string title ) : void	Sets the title of the progress dialog
SetValue ( int value ) : void	Sets the number of items processed
Show ( int max, bool canCancel ) : void	Shows the progress dialog
Stop ( ) : void	Stops and closes the progress dialog

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.

Method	Description
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
LaunchForm ( ) : void
ProgressDialog ( ) : System
btnCancel_Click ( object sender, EventArgs e ) : void

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true if managed resources should be disposed; otherwise, false.
return	void

Sets the maximum value. If the maximum is less than or equal to 0, then the progress animation will become marquee.

public static SetMax ( int max ) : void
max	int	The max.
return	void

Sets the message of the progress dialog

public static SetMessage ( string message ) : void
message	string	The message.
return	void

Sets the title of the progress dialog

public static SetTitle ( string title ) : void
title	string	The title.
return	void

Sets the number of items processed

public static SetValue ( int value ) : void
value	int	The value.
return	void

Shows the progress dialog

public static Show ( int max, bool canCancel ) : void
max	int	The maximum value. If less than or equal to 0, the progress bar will use the marquee animation
canCancel	bool	if set to true, the user can cancel the operation. In this case, the must be handled
return	void

Stops and closes the progress dialog

public static Stop ( ) : void
return	void

text which is shown in front of the numbers; e.g. actionText 102/999

public static string actionBaseText
return	string

text which can be shown as action which is done at the moment

public static string actionText
return	string