C# Class SIL.FieldWorks.IText.InterlinearSfmImportWizard

Mostra file Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property Type Description
label2 System.Windows.Forms.Label
m_cache FdoCache

Private Properties

Property Type Description
AddSimpleItems void
CalculateTextCount int
DoConversion object
GetDefaultInputSettingsPath string
GetDefaultOutputSettingsPath string
GetDestinationName string
GetFile string
GetFiles string
GetWritingSystemName string
InitializeComponent void
JoinPaths string
LoadSettings List
MakeEndOfTextVisibleAndFocus void
OnFinishButton void
SaveSettings void
SplitPaths string[]
m_browseInputFilesButton_Click void
m_browseLoadSettingsFileButon_Click void
m_browseSaveSettingsFileButon_Click void
m_btnCancel_Click void
m_btnHelp_Click void
m_mappingsList_MouseDoubleClick void
m_modifyMappingButton_Click void
m_useDefaultSettingsLink_LinkClicked void

Public Methods

Method Description
Init ( FdoCache cache, Mediator mediator ) : void
InterlinearSfmImportWizard ( ) : System

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

DoStage2Conversion ( byte stage1, IThreadedProgress dlg ) : void
GetDefaultWs ( InterlinearMapping mapping ) : int
GetDestinationsFilter ( ) : IEnumerable

Provides the InterlinearDestinations that should be available in Modify Mapping dlg

GetSfmConverter ( ) : Sfm2FlexTextBase
OnKeyDown ( object sender, KeyEventArgs e ) : void
OnKeyUp ( object sender, KeyEventArgs e ) : void
OnNextButton ( ) : void
SetDialogTitle ( ) : void
ValidToGoForward ( ) : bool
ValidateReadyToImport ( ) : bool

Private Methods

Method Description
AddSimpleItems ( List results, string remaining ) : void
CalculateTextCount ( List mMappings, int>.Dictionary dictionary ) : int

Given the mapping and followed by information from the file calculate how many texts will result from an import.

DoConversion ( IThreadedProgress dlg, object parameters ) : object

Do the conversion. The signature of this method is required for use with ProgressDialogWithTask.RunTask, but the parameters and return result are not actually used.

GetDefaultInputSettingsPath ( ) : string
GetDefaultOutputSettingsPath ( string input ) : string
GetDestinationName ( InterlinDestination dest ) : string
GetFile ( string currentFile, string pathForInitialDirectory, FileFilterType types, bool checkFileExists, string title, bool>.Func isValidFile ) : string
GetFiles ( string currentFiles ) : string
GetWritingSystemName ( string wsid ) : string
InitializeComponent ( ) : void
JoinPaths ( string paths ) : string
LoadSettings ( ) : List
MakeEndOfTextVisibleAndFocus ( TextBox textBox ) : void

Make sure that the end of the text in the given text box is visible. An (undesired) side effect is to focus the box and put the selection at the end of it. I cannot find any portable way to achieve the desired scrolling without doing this.

OnFinishButton ( ) : void
SaveSettings ( ) : void
SplitPaths ( string input ) : string[]
m_browseInputFilesButton_Click ( object sender, EventArgs e ) : void
m_browseLoadSettingsFileButon_Click ( object sender, EventArgs e ) : void
m_browseSaveSettingsFileButon_Click ( object sender, EventArgs e ) : void
m_btnCancel_Click ( object sender, EventArgs e ) : void
m_btnHelp_Click ( object sender, EventArgs e ) : void
m_mappingsList_MouseDoubleClick ( object sender, MouseEventArgs e ) : void
m_modifyMappingButton_Click ( object sender, EventArgs e ) : void
m_useDefaultSettingsLink_LinkClicked ( object sender, LinkLabelLinkClickedEventArgs e ) : void

Method Details

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

DoStage2Conversion() protected method

protected DoStage2Conversion ( byte stage1, IThreadedProgress dlg ) : void
stage1 byte
dlg IThreadedProgress
return void

GetDefaultWs() protected method

protected GetDefaultWs ( InterlinearMapping mapping ) : int
mapping InterlinearMapping
return int

GetDestinationsFilter() protected method

Provides the InterlinearDestinations that should be available in Modify Mapping dlg
protected GetDestinationsFilter ( ) : IEnumerable
return IEnumerable

GetSfmConverter() protected method

protected GetSfmConverter ( ) : Sfm2FlexTextBase
return Sfm2FlexTextBase

Init() public method

public Init ( FdoCache cache, Mediator mediator ) : void
cache FdoCache
mediator Mediator
return void

InterlinearSfmImportWizard() public method

public InterlinearSfmImportWizard ( ) : System
return System

OnKeyDown() protected method

protected OnKeyDown ( object sender, KeyEventArgs e ) : void
sender object
e KeyEventArgs
return void

OnKeyUp() protected method

protected OnKeyUp ( object sender, KeyEventArgs e ) : void
sender object
e KeyEventArgs
return void

OnNextButton() protected method

protected OnNextButton ( ) : void
return void

SetDialogTitle() protected method

protected SetDialogTitle ( ) : void
return void

ValidToGoForward() protected method

protected ValidToGoForward ( ) : bool
return bool

ValidateReadyToImport() protected method

protected ValidateReadyToImport ( ) : bool
return bool

Property Details

label2 protected_oe property

protected System.Windows.Forms.Label label2
return System.Windows.Forms.Label

m_cache protected_oe property

protected FdoCache m_cache
return FdoCache