C# Class SIL.FieldWorks.FwCoreDlgs.CnvtrPropertiesCtrl

Summary description for CnvtrPropertiesCtrl.

Public so we can test it

Inheritance: System.Windows.Forms.UserControl, IFWDisposable

ファイルを表示 Open project: sillsdev/FieldWorks Class Usage Examples

Public Properties

Property	Type	Description
btnMapFile	System.Windows.Forms.Button
cboConversion	SIL.FieldWorks.Common.Controls.FwOverrideComboBox
cboConverter	SIL.FieldWorks.Common.Controls.FwOverrideComboBox
cboSpec	SIL.FieldWorks.Common.Controls.FwOverrideComboBox
m_specs	string
m_supportedConverter	bool
txtMapFile	System.Windows.Forms.TextBox
txtName	System.Windows.Forms.TextBox

Private Properties

Property	Type	Description
AddToCollection	void
AutoConfigureEx	bool
CompareEncInfo	int
GetConverterStringForType	string
InitializeComponent	void
SetConverterType	void
SetReadyToGiveCodePage	void
SetReadyToGiveMapFile	void
SetReadyToGiveRegEx	void
SetReadyToGiveSpec	void
SetStates	void
btnMapFile_Click	void
btnModify_Click	void
btnMore_Click	void
cboConversion_SelectedIndexChanged	void
cboConverter_SelectedIndexChanged	void
cboSpec_SelectedIndexChanged	void
txtName_TextChanged	void

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.
CnvtrPropertiesCtrl ( ) : System	Initializes a new instance of the T:CnvtrPropertiesCtrl class.
CnvtrPropertiesCtrl_Load ( object sender, System e ) : void	Occurs on loading the Properties Tab
EnableEntirePane ( bool toState ) : void	Enable/Disable everything in the pane
RaiseConverterFileChanged ( ) : void	The coverter has changed. Notify anyone who cares.
RaiseConverterSaved ( ) : void	We saved a new or modified mapping, notify anyone who cares.
RaiseListChanged ( ) : void	Something that happened in our control changed the list of mappings. Notify anyone who cares.
SelectMapping ( string mapname ) : void	In the standard usage, this is called from the selection changed event handler of the combo box that shows the installed mappings.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnConverterFileChanged ( EventArgs ea ) : void	A converter has been modified. The default handler just notifies delegates.
OnConverterListChanged ( EventArgs ea ) : void	Raises the converter list changed event.
OnConverterSaved ( EventArgs ea ) : void	A new converter has been added or a modified one saved. The default handler just notifies delegates.
txtMapFile_TextChanged ( object sender, System e ) : void	Triggered when the text has been changed

Private Methods

Method	Description
AddToCollection ( IEncConverter rConverter, string converterName ) : void	Adds the converter to the collection.
AutoConfigureEx ( IEncConverter rIEncConverter, ConvType eConversionTypeFilter, string &strFriendlyName, string strLhsEncodingID, string strRhsEncodingID ) : bool	Automatically configures.
CompareEncInfo ( System x, System y ) : int
GetConverterStringForType ( ConverterType type ) : string	Gets the string mapped to the type for the converter.
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
SetConverterType ( ConvType setConvType ) : void	Sets the type of the converter in the combobox for the currently selected encoding converter.
SetReadyToGiveCodePage ( ) : void
SetReadyToGiveMapFile ( ) : void
SetReadyToGiveRegEx ( ) : void
SetReadyToGiveSpec ( ) : void
SetStates ( bool existingConvs, bool installedConverter ) : void	Sets the states.
btnMapFile_Click ( object sender, System e ) : void	Handles the Click event of the btnMapFile control.
btnModify_Click ( object sender, EventArgs e ) : void
btnMore_Click ( object sender, EventArgs e ) : void
cboConversion_SelectedIndexChanged ( object sender, System e ) : void	Handles the SelectedIndexChanged event of the cboConversion control.
cboConverter_SelectedIndexChanged ( object sender, System e ) : void
cboSpec_SelectedIndexChanged ( object sender, System e ) : void	Handles the SelectedIndexChanged event of the cboSpec control.
txtName_TextChanged ( object sender, System e ) : void	Handles the TextChanged event of the txtName control.

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.

public CheckDisposed ( ) : void
return	void

CnvtrPropertiesCtrl() public method

Initializes a new instance of the T:CnvtrPropertiesCtrl class.

public CnvtrPropertiesCtrl ( ) : System
return	System

CnvtrPropertiesCtrl_Load() public method

Occurs on loading the Properties Tab

public CnvtrPropertiesCtrl_Load ( object sender, System e ) : void
sender	object	The source of the event.
e	System	The instance containing the event /// data.
return	void

Dispose() protected method

Clean up any resources being used.

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

EnableEntirePane() public method

Enable/Disable everything in the pane

public EnableEntirePane ( bool toState ) : void
toState	bool	True if enabling, False if disabling.
return	void

OnConverterFileChanged() protected method

A converter has been modified. The default handler just notifies delegates.

protected OnConverterFileChanged ( EventArgs ea ) : void
ea	System.EventArgs
return	void

OnConverterListChanged() protected method

Raises the converter list changed event.

protected OnConverterListChanged ( EventArgs ea ) : void
ea	System.EventArgs	The instance containing the event /// data.
return	void

OnConverterSaved() protected method

A new converter has been added or a modified one saved. The default handler just notifies delegates.

protected OnConverterSaved ( EventArgs ea ) : void
ea	System.EventArgs
return	void

RaiseConverterFileChanged() public method

The coverter has changed. Notify anyone who cares.

public RaiseConverterFileChanged ( ) : void
return	void

RaiseConverterSaved() public method

We saved a new or modified mapping, notify anyone who cares.

public RaiseConverterSaved ( ) : void
return	void

RaiseListChanged() public method

Something that happened in our control changed the list of mappings. Notify anyone who cares.

public RaiseListChanged ( ) : void
return	void

SelectMapping() public method

In the standard usage, this is called from the selection changed event handler of the combo box that shows the installed mappings.

public SelectMapping ( string mapname ) : void
mapname	string
return	void

txtMapFile_TextChanged() protected method

Triggered when the text has been changed

protected txtMapFile_TextChanged ( object sender, System e ) : void
sender	object
e	System
return	void

Property Details

btnMapFile public_oe property

public Button,System.Windows.Forms btnMapFile
return	System.Windows.Forms.Button

cboConversion public_oe property

public FwOverrideComboBox,SIL.FieldWorks.Common.Controls cboConversion
return	SIL.FieldWorks.Common.Controls.FwOverrideComboBox

cboConverter public_oe property

public FwOverrideComboBox,SIL.FieldWorks.Common.Controls cboConverter
return	SIL.FieldWorks.Common.Controls.FwOverrideComboBox

cboSpec public_oe property

public FwOverrideComboBox,SIL.FieldWorks.Common.Controls cboSpec
return	SIL.FieldWorks.Common.Controls.FwOverrideComboBox

m_specs public_oe property

The actual specs string that will be used to initialize a new converter.

public string m_specs
return	string

m_supportedConverter public_oe property

Is the loaded converter supported? True if no conv is loaded. Basically, we're just trying to find out if we should prevent the user from changing a converter that we are unable to modify.

public bool m_supportedConverter
return	bool

txtMapFile public_oe property

public TextBox,System.Windows.Forms txtMapFile
return	System.Windows.Forms.TextBox

txtName public_oe property

name of the converter

public TextBox,System.Windows.Forms txtName
return	System.Windows.Forms.TextBox