C# Class SIL.FieldWorks.TE.ImportDialog

ImportDialog - gather information for a data import

Inheritance: System.Windows.Forms.Form, IFWDisposable

Protected Properties

Property	Type	Description
m_StyleSheet	FwStyleSheet
m_importSettings	IScrImportSet
m_scr	IScripture
scrPsgFrom	SIL.FieldWorks.Common.Controls.ScrBookControl
scrPsgTo	SIL.FieldWorks.Common.Controls.ScrBookControl

Property	Type	Description
InitBookNameList	int
InitializeComponent	void
InitializeStartAndEndRefControls	void
SetEndRefToLastImportableBook	void
SetStartRefToFirstImportableBook	void
TypeOfDataToImportChanged	void
btnHelp_Click	void
btnSource_Click	void
radImportRange_CheckedChanged	void

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.
ClearDialogReferences ( ) : void	Clears the starting and ending references in this dialog.
ImportDialog ( ) : System	Default constructor for import dialog. Don't use this constructor at run time.
ImportDialog ( FwStyleSheet styleSheet, SIL.FieldWorks.FDO.FdoCache cache, IScrImportSet settings, IHelpTopicProvider helpTopicProvider, IApp app ) : System	Constructor for import dialog, requiring a language project. Use this constructor at run time.

Method	Description
OnClosing ( CancelEventArgs e ) : void	If the user didn't choose cancel, save the controls' values.
scrPsgFrom_PassageChanged ( ScrReference newReference ) : void	Handle a change in the scripture passage "from" control
scrPsgTo_PassageChanged ( ScrReference newReference ) : void	Handle a change in the scripture passage "to" control

Method	Description
InitBookNameList ( ) : int	Initialize a list of book names available from the import file list.
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
InitializeStartAndEndRefControls ( ) : void	Initializes the start and end ref controls.
SetEndRefToLastImportableBook ( ) : void	Sets the end ref to last book available for import.
SetStartRefToFirstImportableBook ( ) : void	Sets the start ref to first book available for import.
TypeOfDataToImportChanged ( object sender, System e ) : void	Handle a change to the import type
btnHelp_Click ( object sender, System e ) : void	Bring up the help when the help button is clicked.
btnSource_Click ( object sender, System e ) : void	When the Source button is clicked, display the import wizard.
radImportRange_CheckedChanged ( object sender, System e ) : void	The scripture passage controls are only relevant when the user wants to import a range.

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

Clears the starting and ending references in this dialog.

public static ClearDialogReferences ( ) : void
return	void

Default constructor for import dialog. Don't use this constructor at run time.

public ImportDialog ( ) : System
return	System

Constructor for import dialog, requiring a language project. Use this constructor at run time.

public ImportDialog ( FwStyleSheet styleSheet, SIL.FieldWorks.FDO.FdoCache cache, IScrImportSet settings, IHelpTopicProvider helpTopicProvider, IApp app ) : System
styleSheet	FwStyleSheet
cache	SIL.FieldWorks.FDO.FdoCache
settings	IScrImportSet
helpTopicProvider	IHelpTopicProvider
app	IApp
return	System

If the user didn't choose cancel, save the controls' values.

protected OnClosing ( CancelEventArgs e ) : void
e	CancelEventArgs
return	void

Handle a change in the scripture passage "from" control

protected scrPsgFrom_PassageChanged ( ScrReference newReference ) : void
newReference	ScrReference	The new reference.
return	void

Handle a change in the scripture passage "to" control

protected scrPsgTo_PassageChanged ( ScrReference newReference ) : void
newReference	ScrReference	The new reference.
return	void

protected FwStyleSheet m_StyleSheet
return	FwStyleSheet

protected IScrImportSet m_importSettings
return	IScrImportSet

protected IScripture m_scr
return	IScripture

protected ScrBookControl,SIL.FieldWorks.Common.Controls scrPsgFrom
return	SIL.FieldWorks.Common.Controls.ScrBookControl

protected ScrBookControl,SIL.FieldWorks.Common.Controls scrPsgTo
return	SIL.FieldWorks.Common.Controls.ScrBookControl