C# Class SignMaster.ProgressForm

Show file Open project: sillsdevinstaller Class Usage Examples

Public Methods

Method	Description
BeginStep ( string item ) : void	Called when a new progress item of work is started.
EndStep ( string report ) : void	Called when a progress item of work is completed.
Finished ( bool canClose ) : void	Called when all work covered by progress dialog is complete.
Init ( int numSteps ) : void	Initializes the progress dialog.
IsCanceled ( ) : bool
ProgressForm ( ) : System	Constructor

Protected Methods

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

Private Methods

Method	Description
BtnProgressCancelClick ( object sender, EventArgs e ) : void	Response to user pressing Cancel button
DoBeginStep ( string item ) : void	Delegated version of BeginStep().
DoEndStep ( string report ) : void	Delegated version of EndStep().
DoFinished ( bool canClose ) : void	Delegated version of Finished().
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
ScrollProgressTextToBottom ( ) : void	Trick to make sure multi-line text box shows latest text added.

Method Details

BeginStep() public method

Called when a new progress item of work is started.

public BeginStep ( string item ) : void
item	string	Description of work, typically the name of the file about to be signed.
return	void

Dispose() protected method

Clean up any resources being used.

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

EndStep() public method

Called when a progress item of work is completed.

public EndStep ( string report ) : void
report	string	Desciption of any problems encounterd while doing the work step.
return	void

Finished() public method

Called when all work covered by progress dialog is complete.

public Finished ( bool canClose ) : void
canClose	bool	True if work completed successfully.
return	void

Init() public method

Initializes the progress dialog.

public Init ( int numSteps ) : void
numSteps	int	Number of steps of work to be done
return	void

IsCanceled() public method

public IsCanceled ( ) : bool
return	bool

ProgressForm() public method

Constructor

public ProgressForm ( ) : System
return	System