C# Class SIL.FieldWorks.FdoUi.Dialogs.RelatedWordsView

View showing related words. The provided data access should contain the needed data. object hvoEntry has a sequence (ktagDomains) of domains. each domain has a string ktagName and a sequence (ktagWords) of words. each word has a ktagName.

Inheritance: SIL.FieldWorks.Common.RootSites.SimpleRootSite

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Property	Type	Description
HandleSelectionChange	void
SetEntry	void

Public Methods

Method	Description
MakeRoot ( ) : void	Make the root box and initialize it.
RelatedWordsView ( SIL.FieldWorks.FDO.FdoCache cache, int hvoRoot, ITsString headword, ISilDataAccess sda, int wsUser ) : System

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.
OnEditingHelperCreated ( ) : void	Called when the editing helper is created.

Private Methods

Method	Description
HandleSelectionChange ( object sender, SIL.FieldWorks.Common.RootSites.VwSelectionArgs args ) : void	Handle a selection change by growing it to a word (unless the new selection IS the one we're growing to a word).
SetEntry ( int hvoEntry ) : void

Method Details

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

MakeRoot() public method

Make the root box and initialize it.

public MakeRoot ( ) : void
return	void

OnEditingHelperCreated() protected method

Called when the editing helper is created.

protected OnEditingHelperCreated ( ) : void
return	void

RelatedWordsView() public method

public RelatedWordsView ( SIL.FieldWorks.FDO.FdoCache cache, int hvoRoot, ITsString headword, ISilDataAccess sda, int wsUser ) : System
cache	SIL.FieldWorks.FDO.FdoCache
hvoRoot	int
headword	ITsString
sda	ISilDataAccess
wsUser	int
return	System