C# Class SIL.FieldWorks.XWorks.LexEd.LexReferenceMultiSlice

Summary description for LexReferenceMultiSlice.
Inheritance: Slice
Datei anzeigen Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method Description
DeleteFromReference ( ILexReference lr ) : void

This method is called when a user selects Delete Relation on a Lexical Relation slice. For: sequence relations (eg. Calendar) collection relations (eg. Synonym) tree relation (parts/whole when deleting a Whole slice)
DeleteReference ( ILexReference lr ) : void

This method is called when a user selects Delete Relation on a Lexical Relation slice. For: Pair relation (eg. Antonym) tree relation (parts/whole when deleting a Parts slice)
EditReferenceDetails ( ILexReference lr ) : void

This method is called when a user selects "Edit Reference Set Details" for a Lexical Relation slice.
Expand ( int iSlice ) : void

Expand this node, which is at position iSlice in its parent.

I (JH) don't know why this was written to take the index of the slice. It's just as easy for this class to find its own index.

FinishInit ( ) : void

Override method to add suitable control.
GenerateChildren ( XmlNode node, XmlNode caller, ICmObject obj, int indent, int &insPos, ArrayList path, ObjSeqHashMap reuseMap, bool fUsePersistentExpansion ) : void
HandleCreateMenuItem ( object sender, EventArgs ea ) : void
HandleMoreMenuItem ( object sender, EventArgs ea ) : void
HandleMouseDown ( Point p ) : bool
MakeSenseChooser ( SIL.FieldWorks.FDO.FdoCache cache, IHelpTopicProvider helpTopicProvider ) : SIL.FieldWorks.Common.Framework.DetailControls.SimpleListChooser
OnHelp ( object sender, EventArgs args ) : void
OnShowFieldAlwaysVisible1 ( object sender, EventArgs args ) : void
OnShowFieldIfData1 ( object sender, EventArgs args ) : void
OnShowFieldNormallyHidden1 ( object sender, EventArgs args ) : void

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.

ExpandNewNode ( ) : void
UpdateDisplayIfNeeded ( int hvo, int tag ) : bool

Updates the display of a slice, if an hvo and tag it cares about has changed in some way.

Private Methods

Method Description
AddFinalContextMenuStripOptions ( ContextMenuStrip contextMenuStrip ) : void
DisposeContextMenu ( object sender, EventArgs e ) : void
GenerateChildNode ( int iChild, XmlNode node, XmlNode caller, int indent, int &insPos, ArrayList path, ObjSeqHashMap reuseMap ) : void
GetChildObject ( ILexRefType lrt ) : ICmObject

This method is called when we are creating a new lexical relation slice. If the user selects an item it's hvo is returned. Otherwise 0 is returned and the lexical relation should not be created.
GetRootObject ( ILexRefType lrt ) : ICmObject

This method is called when we are creating a new lexical relation slice. If the user selects an item it's hvo is returned. Otherwise 0 is returned and the lexical relation should not be created.
SetRefs ( ) : void
SetupContextMenuStrip ( ) : ContextMenuStrip
UpdateForDelete ( ILexReference lr ) : void
contextMenuStrip_Closed ( object sender, System.Windows.Forms.ToolStripDropDownClosedEventArgs e ) : void

Method Details

DeleteFromReference() public method

This method is called when a user selects Delete Relation on a Lexical Relation slice. For: sequence relations (eg. Calendar) collection relations (eg. Synonym) tree relation (parts/whole when deleting a Whole slice)
public DeleteFromReference ( ILexReference lr ) : void
lr ILexReference
return void

DeleteReference() public method

This method is called when a user selects Delete Relation on a Lexical Relation slice. For: Pair relation (eg. Antonym) tree relation (parts/whole when deleting a Parts slice)
public DeleteReference ( ILexReference lr ) : void
lr ILexReference
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

EditReferenceDetails() public method

This method is called when a user selects "Edit Reference Set Details" for a Lexical Relation slice.
public EditReferenceDetails ( ILexReference lr ) : void
lr ILexReference
return void

Expand() public method

Expand this node, which is at position iSlice in its parent.
I (JH) don't know why this was written to take the index of the slice. It's just as easy for this class to find its own index.
public Expand ( int iSlice ) : void
iSlice int
return void

ExpandNewNode() protected method

protected ExpandNewNode ( ) : void
return void

FinishInit() public method

Override method to add suitable control.
public FinishInit ( ) : void
return void

GenerateChildren() public method

public GenerateChildren ( XmlNode node, XmlNode caller, ICmObject obj, int indent, int &insPos, ArrayList path, ObjSeqHashMap reuseMap, bool fUsePersistentExpansion ) : void
node System.Xml.XmlNode
caller System.Xml.XmlNode
obj ICmObject
indent int
insPos int
path System.Collections.ArrayList
reuseMap SIL.FieldWorks.Common.Framework.DetailControls.ObjSeqHashMap
fUsePersistentExpansion bool
return void

HandleCreateMenuItem() public method

public HandleCreateMenuItem ( object sender, EventArgs ea ) : void
sender object
ea System.EventArgs
return void

HandleMoreMenuItem() public method

public HandleMoreMenuItem ( object sender, EventArgs ea ) : void
sender object
ea System.EventArgs
return void

HandleMouseDown() public method

public HandleMouseDown ( Point p ) : bool
p Point
return bool

MakeSenseChooser() public static method

public static MakeSenseChooser ( SIL.FieldWorks.FDO.FdoCache cache, IHelpTopicProvider helpTopicProvider ) : SIL.FieldWorks.Common.Framework.DetailControls.SimpleListChooser
cache SIL.FieldWorks.FDO.FdoCache
helpTopicProvider IHelpTopicProvider
return SIL.FieldWorks.Common.Framework.DetailControls.SimpleListChooser

OnHelp() public method

public OnHelp ( object sender, EventArgs args ) : void
sender object
args System.EventArgs
return void

OnShowFieldAlwaysVisible1() public method

public OnShowFieldAlwaysVisible1 ( object sender, EventArgs args ) : void
sender object
args System.EventArgs
return void

OnShowFieldIfData1() public method

public OnShowFieldIfData1 ( object sender, EventArgs args ) : void
sender object
args System.EventArgs
return void

OnShowFieldNormallyHidden1() public method

public OnShowFieldNormallyHidden1 ( object sender, EventArgs args ) : void
sender object
args System.EventArgs
return void

UpdateDisplayIfNeeded() protected method

Updates the display of a slice, if an hvo and tag it cares about has changed in some way.
protected UpdateDisplayIfNeeded ( int hvo, int tag ) : bool
hvo int
tag int
return bool