C# Class SIL.FieldWorks.FdoUi.LexSenseUi

UI functions for MoMorphSynAnalysis.
Inheritance: CmObjectUi
Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method Description
CreateNewUiObject ( XCore.Mediator mediator, int classId, int hvoOwner, int flid, int insertionPosition ) : LexSenseUi

When inserting a LexSense, copy the MSA from the one we are inserting after, or the first one. If this is the first one, we may need to create an MSA if the owning entry does not have an appropriate one.
GuidForJumping ( object commandObject ) : System.Guid

gives the hvo of the object to use in the URL we construct when doing a jump
LexSenseUi ( ICmObject obj ) : System

Create one.
MoveUnderlyingObjectToCopyOfOwner ( ) : void
OnDisplayDeleteSelectedItem ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool

disable/hide delete selected item for LexSenses (eg. since we don't want them to delete all senses from its owning entry.)

Protected Methods

Method Description
GetMergeinfo ( SIL.FieldWorks.LexText.Controls.WindowParams wp, List mergeCandidates, string &guiControl, string &helpTopic ) : DummyCmObject
ShouldDisplayMenuForClass ( int specifiedClsid, XCore.UIItemDisplayProperties display ) : bool

Private Methods

Method Description
GetSafeHvoMsa ( SIL.FieldWorks.FDO.FdoCache cache, ILexSense ls ) : int

This method will get an hvo for the MSA which the senses MorphoSyntaxAnalysisRA points to. If it is null it will try and find an appropriate one in the owning Entries list, if that fails it will make one and put it there.
LexSenseUi ( ) : System

Method Details

CreateNewUiObject() public static method

When inserting a LexSense, copy the MSA from the one we are inserting after, or the first one. If this is the first one, we may need to create an MSA if the owning entry does not have an appropriate one.
public static CreateNewUiObject ( XCore.Mediator mediator, int classId, int hvoOwner, int flid, int insertionPosition ) : LexSenseUi
mediator XCore.Mediator
classId int
hvoOwner int
flid int
insertionPosition int
return LexSenseUi

GetMergeinfo() protected method

protected GetMergeinfo ( SIL.FieldWorks.LexText.Controls.WindowParams wp, List mergeCandidates, string &guiControl, string &helpTopic ) : DummyCmObject
wp SIL.FieldWorks.LexText.Controls.WindowParams
mergeCandidates List
guiControl string
helpTopic string
return DummyCmObject

GuidForJumping() public method

gives the hvo of the object to use in the URL we construct when doing a jump
public GuidForJumping ( object commandObject ) : System.Guid
commandObject object
return System.Guid

LexSenseUi() public method

Create one.
public LexSenseUi ( ICmObject obj ) : System
obj ICmObject
return System

MoveUnderlyingObjectToCopyOfOwner() public method

public MoveUnderlyingObjectToCopyOfOwner ( ) : void
return void

OnDisplayDeleteSelectedItem() public method

disable/hide delete selected item for LexSenses (eg. since we don't want them to delete all senses from its owning entry.)
public OnDisplayDeleteSelectedItem ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject object
display XCore.UIItemDisplayProperties
return bool

ShouldDisplayMenuForClass() protected method

protected ShouldDisplayMenuForClass ( int specifiedClsid, XCore.UIItemDisplayProperties display ) : bool
specifiedClsid int
display XCore.UIItemDisplayProperties
return bool