C# Class SIL.FieldWorks.TE.TeImportUi

UI elements of import. Gets called from TeImport.

This class needs to deal with multi threading issues since it gets called from TeImport (which runs in the background), but every UI element it creates needs to run on the main thread.

Inheritance: IFWDisposable

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property	Type	Description
m_importer	TeImporter

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. This method is thread safe.
Dispose ( ) : void	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
ErrorMessage ( string message ) : void	Displays an import error message.
Step ( int cSteps ) : void
TeImportUi ( ProgressDialogWithTask progressDialog, IHelpTopicProvider helpTopicProvider ) : System	Initializes a new instance of the TeImportUi class.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void

Private Methods

Method	Description
ErrorMessage ( SIL.FieldWorks.Common.ScriptureUtils.EncodingConverterException e ) : void
OnCancelPressed ( object sender, System.CancelEventArgs e ) : void	Called when the user pressed the cancel button on the progress dialog.

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.

This method is thread safe.

public CheckDisposed ( ) : void
return	void

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public Dispose ( ) : void
return	void

Dispose() protected method

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

ErrorMessage() public method

Displays an import error message.

public ErrorMessage ( string message ) : void
message	string	The message.
return	void

Step() public method

public Step ( int cSteps ) : void
cSteps	int
return	void

TeImportUi() public method

Initializes a new instance of the TeImportUi class.

public TeImportUi ( ProgressDialogWithTask progressDialog, IHelpTopicProvider helpTopicProvider ) : System
progressDialog	SIL.FieldWorks.Common.Controls.ProgressDialogWithTask	The progress dialog.
helpTopicProvider	IHelpTopicProvider	The help topic provider.
return	System

Property Details

m_importer protected property

protected TeImporter,SIL.FieldWorks.TE m_importer
return	TeImporter