C# Class SIL.FieldWorks.IText.ChooseAnalysisHandler

This class handles the functions of the combo box that is used to choose a different existing analysis.
Inheritance: IComboHandler, IFWDisposable
Datei anzeigen Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property Type Description
s_baseFontSize int

Private Properties

Property Type Description
AddAnalysisItems void
AddItem void
AddItem void
AddSeparatorLine void
MakeAnalysisStringRep ITsString
MakeGlossStringRep ITsString
m_combo_SelectedIndexChanged void

Public Methods

Method Description
Activate ( SIL loc ) : void

Display the combo box at the specified location, or the list box pulled down from the specified location.
CheckDisposed ( ) : void

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
ChooseAnalysisHandler ( SIL.FieldWorks.FDO.FdoCache cache, int hvoSrc, int hvoAnalysis, IComboList comboList ) : System
Dispose ( ) : void

Must not be virtual.

FormTextProperties ( SIL.FieldWorks.FDO.FdoCache fdoCache, bool fUseStyleSheet, int wsVern ) : ITsTextProps

GetAnalysisTree ( ) : AnalysisTree

Initially, the analysis we based the list on. After the user makes a selection, the selection he made.
GlossTextProperties ( SIL.FieldWorks.FDO.FdoCache fdoCache, bool inAnalysisLine, bool fUseStyleSheet ) : ITsTextProps
HandleReturnKey ( ) : bool

Implement required interface method; will never be called because editing not allowed.
HandleSelectIfActive ( ) : void

Required interface method, not relevant for this class.
Hide ( ) : void

Get rid of the combo, typically when the user clicks outside it.
PartOfSpeechTextProperties ( SIL.FieldWorks.FDO.FdoCache fdoCache, bool inAnalysisLine, bool fUseStyleSheet ) : ITsTextProps

SetupCombo ( ) : void

Initialize the combo contents.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.

MakeSimpleString ( String str ) : ITsString

Private Methods

Method Description
AddAnalysisItems ( IWfiAnalysis wa ) : void

Add the items for this WfiAnalysis (itself and ones it owns).
AddItem ( ICmObject co, ITsString text, bool fPossibleCurrent ) : void

Add an item to the combo box, but only if its text is non-empty.
AddItem ( ICmObject co, ITsString text, bool fPossibleCurrent, int tag ) : void

Add an item to the combo box, but only if its text is non-empty.
AddSeparatorLine ( ) : void
MakeAnalysisStringRep ( IWfiAnalysis wa, SIL.FieldWorks.FDO.FdoCache fdoCache, bool fUseStyleSheet, int wsVern ) : ITsString
MakeGlossStringRep ( IWfiGloss wg, SIL.FieldWorks.FDO.FdoCache fdoCache, bool fUseStyleSheet ) : ITsString
m_combo_SelectedIndexChanged ( object sender, EventArgs e ) : void

Handle the user selecting something in the combo.

Method Details

Activate() public method

Display the combo box at the specified location, or the list box pulled down from the specified location.
public Activate ( SIL loc ) : void
loc SIL
return void

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

ChooseAnalysisHandler() public method

public ChooseAnalysisHandler ( SIL.FieldWorks.FDO.FdoCache cache, int hvoSrc, int hvoAnalysis, IComboList comboList ) : System
cache SIL.FieldWorks.FDO.FdoCache
hvoSrc int
hvoAnalysis int
comboList IComboList
return System

Dispose() public method

Must not be virtual.
public Dispose ( ) : void
return void

Dispose() protected method

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.
If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.
protected Dispose ( bool disposing ) : void
disposing bool
return void

FormTextProperties() public static method

public static FormTextProperties ( SIL.FieldWorks.FDO.FdoCache fdoCache, bool fUseStyleSheet, int wsVern ) : ITsTextProps
fdoCache SIL.FieldWorks.FDO.FdoCache
fUseStyleSheet bool
wsVern int
return ITsTextProps

GetAnalysisTree() public method

Initially, the analysis we based the list on. After the user makes a selection, the selection he made.
public GetAnalysisTree ( ) : AnalysisTree
return AnalysisTree

GlossTextProperties() public static method

public static GlossTextProperties ( SIL.FieldWorks.FDO.FdoCache fdoCache, bool inAnalysisLine, bool fUseStyleSheet ) : ITsTextProps
fdoCache SIL.FieldWorks.FDO.FdoCache
inAnalysisLine bool
fUseStyleSheet bool
return ITsTextProps

HandleReturnKey() public method

Implement required interface method; will never be called because editing not allowed.
public HandleReturnKey ( ) : bool
return bool

HandleSelectIfActive() public method

Required interface method, not relevant for this class.
public HandleSelectIfActive ( ) : void
return void

Hide() public method

Get rid of the combo, typically when the user clicks outside it.
public Hide ( ) : void
return void

MakeSimpleString() protected method

protected MakeSimpleString ( String str ) : ITsString
str String
return ITsString

PartOfSpeechTextProperties() public static method

public static PartOfSpeechTextProperties ( SIL.FieldWorks.FDO.FdoCache fdoCache, bool inAnalysisLine, bool fUseStyleSheet ) : ITsTextProps
fdoCache SIL.FieldWorks.FDO.FdoCache
inAnalysisLine bool
fUseStyleSheet bool
return ITsTextProps

SetupCombo() public method

Initialize the combo contents.
public SetupCombo ( ) : void
return void

Property Details

s_baseFontSize static_oe protected_oe property

this is something of a hack until we convert to using a style sheet
static protected int s_baseFontSize
return int