C# Class SIL.FieldWorks.LexText.Controls.LexImportWizard

Inheritance: SIL.FieldWorks.Common.Controls.WizardDialog, IFwExtension
ファイルを表示 Open project: sillsdev/FieldWorks Class Usage Examples

Public Properties

Property Type Description
m_CustomFields Sfm2Xml.ILexImportFields
m_LexFields Sfm2Xml.ILexImportFields

Public Methods

Method Description
AddInLineMarker ( Sfm2Xml marker, bool makeSelected ) : bool
AddLanguage ( string langDesc, string ws, string ec, string wsId ) : bool
EnsureWindows1252ConverterExists ( ) : void
GetUILanguages ( ) : Hashtable
GetUI_InlineMarkers ( ) : Hashtable
LexImportWizard ( ) : System

Create the Wizard and require an FdoCache object.

ReadCustomFieldsFromDB ( bool &changed ) : Sfm2Xml.ILexImportFields
Wizard ( ) : LexImportWizard

public static method to allow other objects in this namespace to get a copy of the current wizard.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

GetCustomFieldHelp ( SIL.FieldWorks.FDO.FieldDescription fd ) : string
MakeVaildXML ( string input ) : string
OnBackButton ( ) : void
OnCancelButton ( ) : void
OnFinishButton ( ) : void
OnHelpButton ( ) : void
OnLoad ( EventArgs e ) : void
OnNextButton ( ) : void
OnResize ( EventArgs e ) : void
OnSizeChanged ( EventArgs e ) : void
ValidToGoForward ( ) : bool

This method will allow or disallow the next buttong to function.

Private Methods

Method Description
AllowQuickFinishButton ( ) : bool
CheckForMapFileVersionChanges ( Sfm2Xml data ) : void

This method will check for changes to the data due to a differnt version: for example 4.5.1 relase to 6.0 relase. This should be improved in the future to pass in the previous version so more concrete decisions can be made.

CheckForPhaseFileName ( ) : bool
CheckIfInputFileHasChanged ( ) : bool
ComputeDisplayWidth ( string label, Font font ) : int
ConvertNameFromIdtoFW ( string wsId ) : string
CreateLanguageMappingItem ( string langDesc, string ws, string ec, string wsId ) : System.Windows.Forms.ListViewItem
DisplayBeginMarkers ( ) : void
DisplayInlineMarkers ( ) : void
DisplayMarkerStep ( ) : void
EnableNextButton ( ) : bool
ExtractExistingBeginMarkers ( bool fIgnoreSelected ) : Hashtable
ExtractExistingElementNames ( bool fIgnoreSelected ) : Hashtable
ExtractExistingEndMarkers ( bool fIgnoreSelected ) : Hashtable
FieldDescriptionToLexImportField ( SIL.FieldWorks.FDO.FieldDescription fd ) : Sfm2Xml.LexImportCustomField
FindDBSettingsSaved ( string dbToImport, string &settings, string &saveAs ) : bool

get the registry settings for this DB if they exist already

FindFilesForDatabaseFile ( string dbToImport ) : void

Get the Settings and Save as values for the passed in DB file

FixControlLocation ( Control control, int maxRight ) : void
FixControlWidth ( Control control, int maxRight ) : void
GetCustomFields ( SIL.FieldWorks.FDO.FdoCache cache ) : void
GetDictionaryFileAsPhaseFileNumber ( ) : int

Use the database file name on the dlg as the text to see if it's a PhaseX file

GetDictionaryFileAsPhaseFileNumber ( string fileName ) : int

See if the file passed in is one of the valid phaseX file names

GetFile ( OFType fileType, string currentFile ) : string
GetLastImportFile ( string &fileName ) : bool
GetNewMediator ( ) : void
GetTempDir ( ) : string
HandleDBFileNameChanges ( ) : void
HasCheckedChild ( TreeNode node ) : int

Get information about the number of checked children.

IFwExtension ( SIL.FieldWorks.FDO.FdoCache cache, XCore mediator ) : void

From IFwExtension

InitOutputFiles ( ) : void
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

IslxFieldAlreadyUnicode ( ) : bool

Return true if the 'lx' marker language is already in unicode.

LexImportWizard_Closing ( object sender, System e ) : void
LexImportWizard_Load ( object sender, System e ) : void
MoveButton ( Button btn, Button btnLeft, int y ) : void
MoveButton ( Button btn, int dw, int dh ) : void
MoveButton2 ( Button btn, int dw, int YCoord ) : void
OnImportError ( object sender, string message, string caption ) : void
ProcessErrorLogCautions ( System xmlMap, string &sHtmlOUT ) : void
ProcessErrorLogErrors ( System xmlMap, string &sHtml ) : int
ProcessErrorLogSfmInfo ( System xmlMap, string &sHtml ) : void
ProcessErrorLogWarnings ( System xmlMap, string &sHtml ) : int
ProcessPhase1Errors ( string filename, string m_sCheckedMapFileName, int m_cEntries, bool fShow ) : bool

read and process the conversion log output data.

ReadIFMFromMapFile ( ) : void
ReadLanguageInfoFromMapFile ( ) : void
ReadMarkersFromDataFile ( ) : void
RemoveTheFileExtension ( string fileName ) : string
SaveNewMapFile ( ) : void

This method produces the map file that will contain the info in the GUI up to this point.

SaveSettings ( ) : void

Save / persist the settings file name and the save as file name for this database file name.

SetCharMappingsButtons ( ) : void

Called when the contents to the infield markers control change so that the modify and delete buttons can be enabled or disabled depending on if there are any selections selected.

SetDatabaseNameIntoLabel ( ) : void
SetListViewItemColor ( System.Windows.Forms.ListViewItem &item ) : void
ShowFinishLabel ( ) : void
ShowSaveButtonOrNot ( ) : void
Step5NextButtonEnabled ( ) : bool
UpdateIfInputFileContentsChanged ( ) : bool
UsesInvalidFileNames ( bool runSilent ) : bool
ViewHtmlReport ( string sHtmlFile ) : void
btnAddCharMapping_Click ( object sender, System e ) : void
btnAddMappingLanguage_Click ( object sender, EventArgs e ) : void
btnBackup_Click ( object sender, System e ) : void
btnDatabaseBrowse_Click ( object sender, System e ) : void
btnDeleteCharMapping_Click ( object sender, System e ) : void
btnGenerateReport_Click ( object sender, System e ) : void

This button runs the feasability check and then enables the next button so the user can continue on.

btnModifyCharMapping_Click ( object sender, System e ) : void
btnModifyContentMapping_Click ( object sender, System e ) : void
btnModifyMappingLanguage_Click ( object sender, EventArgs e ) : void
btnQuickFinish_Click ( object sender, System e ) : void
btnSaveAsBrowse_Click ( object sender, System e ) : void
btnSaveMapFile_Click ( object sender, System e ) : void
btnSettingsBrowse_Click ( object sender, System e ) : void
listViewCharMappings_DoubleClick ( object sender, System e ) : void
listViewCharMappings_SelectedIndexChanged ( object sender, EventArgs e ) : void
listViewContentMapping_ColumnClick ( object sender, System e ) : void
listViewContentMapping_DoubleClick ( object sender, System e ) : void
listViewContentMapping_SelectedIndexChanged ( object sender, System e ) : void
listViewMappingLanguages_ColumnClick ( object sender, ColumnClickEventArgs e ) : void
listViewMappingLanguages_DoubleClick ( object sender, System e ) : void
listViewMappingLanguages_SelectedIndexChanged ( object sender, EventArgs e ) : void
m_DatabaseFileName_TextChanged ( object sender, System e ) : void
m_DisplayImportReport_KeyDown ( object sender, System e ) : void
m_DisplayImportReport_KeyUp ( object sender, System e ) : void
m_SaveAsFileName_TextChanged ( object sender, System e ) : void
m_SettingsFileName_TextChanged ( object sender, System e ) : void
tvBeginMarkers_BeforeCollapse ( object sender, TreeViewCancelEventArgs e ) : void
tvBeginMarkers_HandleCheckBoxNode ( TreeNode tn ) : void
tvBeginMarkers_KeyUp ( object obj, KeyEventArgs kea ) : void
tvBeginMarkers_MouseUp ( object obj, MouseEventArgs mea ) : void

Method Details

AddInLineMarker() public method

public AddInLineMarker ( Sfm2Xml marker, bool makeSelected ) : bool
marker Sfm2Xml
makeSelected bool
return bool

AddLanguage() public method

public AddLanguage ( string langDesc, string ws, string ec, string wsId ) : bool
langDesc string
ws string
ec string
wsId string
return bool

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EnsureWindows1252ConverterExists() public static method

public static EnsureWindows1252ConverterExists ( ) : void
return void

GetCustomFieldHelp() protected method

protected GetCustomFieldHelp ( SIL.FieldWorks.FDO.FieldDescription fd ) : string
fd SIL.FieldWorks.FDO.FieldDescription
return string

GetUILanguages() public method

public GetUILanguages ( ) : Hashtable
return System.Collections.Hashtable

GetUI_InlineMarkers() public method

public GetUI_InlineMarkers ( ) : Hashtable
return System.Collections.Hashtable

LexImportWizard() public method

Create the Wizard and require an FdoCache object.
public LexImportWizard ( ) : System
return System

MakeVaildXML() protected method

protected MakeVaildXML ( string input ) : string
input string
return string

OnBackButton() protected method

protected OnBackButton ( ) : void
return void

OnCancelButton() protected method

protected OnCancelButton ( ) : void
return void

OnFinishButton() protected method

protected OnFinishButton ( ) : void
return void

OnHelpButton() protected method

protected OnHelpButton ( ) : void
return void

OnLoad() protected method

protected OnLoad ( EventArgs e ) : void
e System.EventArgs
return void

OnNextButton() protected method

protected OnNextButton ( ) : void
return void

OnResize() protected method

protected OnResize ( EventArgs e ) : void
e System.EventArgs
return void

OnSizeChanged() protected method

protected OnSizeChanged ( EventArgs e ) : void
e System.EventArgs
return void

ReadCustomFieldsFromDB() public method

public ReadCustomFieldsFromDB ( bool &changed ) : Sfm2Xml.ILexImportFields
changed bool
return Sfm2Xml.ILexImportFields

ValidToGoForward() protected method

This method will allow or disallow the next buttong to function.
protected ValidToGoForward ( ) : bool
return bool

Wizard() public static method

public static method to allow other objects in this namespace to get a copy of the current wizard.
public static Wizard ( ) : LexImportWizard
return LexImportWizard

Property Details

m_CustomFields public_oe property

public Sfm2Xml.ILexImportFields m_CustomFields
return Sfm2Xml.ILexImportFields

m_LexFields public_oe property

public Sfm2Xml.ILexImportFields m_LexFields
return Sfm2Xml.ILexImportFields