C# Class SIL.FieldWorks.Common.Controls.ComplexListChooserBEditControl

This class implements setting a sequence reference property to a set of values chosen from a list.
Inheritance: IBulkEditSpecControl
Mostrar archivo Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property Type Description
m_cache SIL.FieldWorks.FDO.FdoCache
m_flid int
m_hvoList int
m_launcher System.Windows.Forms.Button
m_mediator XCore.Mediator

Private Properties

Property Type Description
BuildValueString ITsString

Public Methods

Method Description
ComplexListChooserBEditControl ( SIL.FieldWorks.FDO.FdoCache cache, XCore.Mediator mediator, XmlNode colSpec ) : System
ComplexListChooserBEditControl ( int flid, int hvoList, string displayNameProperty, string fieldName, string displayWs, SIL.FieldWorks.Common.Controls.GhostParentHelper gph ) : System
DoIt ( IEnumerable itemsToChange, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
FakeDoit ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnabled, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
MakeSuggestions ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnabled, SIL.FieldWorks.Common.Controls.ProgressState state ) : void

Tells SemanticDomainChooserBEditControl to make suggestions and then call FakeDoIt
Right ( string original, int numberCharacters ) : string

C# equivalent of the VB RIGHT function
SetClearField ( ) : void

And does it by setting the list to empty and using overwrite mode.

Protected Methods

Method Description
CanActuallyComputeValuesFor ( int hvoItem, int &hvoReal ) : bool
ComputeValue ( List chosenObjs, int hvoItem, List &oldVals, List &newVal ) : void
DisableItem ( int hvoItem ) : bool

subclasses may override to determine if this hvoItem should be excluded. Basically a kludge to avoid the hassle of trying to figure a way to generate separate lists for variants/complex entry types since they target the same ListItemsClass (LexEntryRef). Currently EntriesOrChildClassesRecordList can only determine which virtual property to load based upon the target ListItemsClass (not a flid). And since we typically don't want the user to change variant types for complex entry refs (or vice-versa), we need some way to filter out items in the list based upon the selected column.
EnableButtonsIfChangesWaiting ( ) : void
GetOldVals ( int hvoReal ) : List
GetRealHvo ( int hvoItem ) : int
m_launcher_Click ( object sender, EventArgs e ) : void

Private Methods

Method Description
BuildValueString ( IEnumerable chosenObjs ) : ITsString

Method Details

CanActuallyComputeValuesFor() protected method

protected CanActuallyComputeValuesFor ( int hvoItem, int &hvoReal ) : bool
hvoItem int
hvoReal int
return bool

ComplexListChooserBEditControl() public method

public ComplexListChooserBEditControl ( SIL.FieldWorks.FDO.FdoCache cache, XCore.Mediator mediator, XmlNode colSpec ) : System
cache SIL.FieldWorks.FDO.FdoCache
mediator XCore.Mediator
colSpec System.Xml.XmlNode
return System

ComplexListChooserBEditControl() public method

public ComplexListChooserBEditControl ( int flid, int hvoList, string displayNameProperty, string fieldName, string displayWs, SIL.FieldWorks.Common.Controls.GhostParentHelper gph ) : System
flid int
hvoList int
displayNameProperty string
fieldName string
displayWs string
gph SIL.FieldWorks.Common.Controls.GhostParentHelper
return System

ComputeValue() protected method

protected ComputeValue ( List chosenObjs, int hvoItem, List &oldVals, List &newVal ) : void
chosenObjs List
hvoItem int
oldVals List
newVal List
return void

DisableItem() protected method

subclasses may override to determine if this hvoItem should be excluded. Basically a kludge to avoid the hassle of trying to figure a way to generate separate lists for variants/complex entry types since they target the same ListItemsClass (LexEntryRef). Currently EntriesOrChildClassesRecordList can only determine which virtual property to load based upon the target ListItemsClass (not a flid). And since we typically don't want the user to change variant types for complex entry refs (or vice-versa), we need some way to filter out items in the list based upon the selected column.
protected DisableItem ( int hvoItem ) : bool
hvoItem int
return bool

DoIt() public method

public DoIt ( IEnumerable itemsToChange, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
itemsToChange IEnumerable
state SIL.FieldWorks.Common.Controls.ProgressState
return void

EnableButtonsIfChangesWaiting() protected method

protected EnableButtonsIfChangesWaiting ( ) : void
return void

FakeDoit() public method

public FakeDoit ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnabled, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
itemsToChange IEnumerable
tagFakeFlid int
tagEnabled int
state SIL.FieldWorks.Common.Controls.ProgressState
return void

GetOldVals() protected method

protected GetOldVals ( int hvoReal ) : List
hvoReal int
return List

GetRealHvo() protected method

protected GetRealHvo ( int hvoItem ) : int
hvoItem int
return int

MakeSuggestions() public method

Tells SemanticDomainChooserBEditControl to make suggestions and then call FakeDoIt
public MakeSuggestions ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnabled, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
itemsToChange IEnumerable
tagFakeFlid int
tagEnabled int
state SIL.FieldWorks.Common.Controls.ProgressState
return void

Right() public method

C# equivalent of the VB RIGHT function
public Right ( string original, int numberCharacters ) : string
original string
numberCharacters int
return string

SetClearField() public method

And does it by setting the list to empty and using overwrite mode.
public SetClearField ( ) : void
return void

m_launcher_Click() protected method

protected m_launcher_Click ( object sender, EventArgs e ) : void
sender object
e System.EventArgs
return void

Property Details

m_cache protected_oe property

protected FdoCache,SIL.FieldWorks.FDO m_cache
return SIL.FieldWorks.FDO.FdoCache

m_flid protected_oe property

protected int m_flid
return int

m_hvoList protected_oe property

protected int m_hvoList
return int

m_launcher protected_oe property

protected Button,System.Windows.Forms m_launcher
return System.Windows.Forms.Button

m_mediator protected_oe property

protected Mediator,XCore m_mediator
return XCore.Mediator