C# Class SIL.FieldWorks.FdoUi.CmPossibilityUi

Special UI behaviors for the CmPossibility class.

Inheritance: CmObjectUi

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
CanDelete ( string &cannotDeleteMsg ) : bool
CheckAndReportProtectedChartColumn ( ) : bool
CmPossibilityUi ( ICmObject obj ) : System	Create one. Argument must be a CmPossibility. Review JohnH (JohnT): should we declare the argument to be CmPossibility? Note that declaring it to be forces us to just do a cast in every case of MakeUi, which is passed an obj anyway.
CreateNewUiObject ( XCore.Mediator mediator, int classId, int hvoOwner, int flid, int insertionPosition ) : CmObjectUi
FormatDisplayTextWithListName ( SIL.FieldWorks.FDO.FdoCache cache, XCore.Mediator mediator, ICmPossibilityList pssl, XCore.UIItemDisplayProperties &display ) : string
OnDisplayJumpToTool ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool

Private Methods

Method	Description
CanDeleteTextMarkupTag ( string &msg ) : bool
CanModifyChartColumn ( string &msg ) : bool
CheckAndReportBadDiscourseTemplateAdd ( SIL.FieldWorks.FDO.FdoCache cache, int hvoItem, int hvoRootItem, int hvoList ) : bool
CheckAndReportBadTagListAdd ( SIL.FieldWorks.FDO.FdoCache cache, int hvoItem, int hvoRootItem, int hvoPossList ) : bool
CheckAndReportProblemAddingSubitem ( SIL.FieldWorks.FDO.FdoCache cache, int hvoItem ) : bool	Check whether it is OK to add a possibility to the specified item. If not, report the problem to the user and return true.
CmPossibilityUi ( ) : System

Method Details

CanDelete() public method

public CanDelete ( string &cannotDeleteMsg ) : bool
cannotDeleteMsg	string
return	bool

CheckAndReportProtectedChartColumn() public method

public CheckAndReportProtectedChartColumn ( ) : bool
return	bool

CmPossibilityUi() public method

Create one. Argument must be a CmPossibility. Review JohnH (JohnT): should we declare the argument to be CmPossibility? Note that declaring it to be forces us to just do a cast in every case of MakeUi, which is passed an obj anyway.

public CmPossibilityUi ( ICmObject obj ) : System
obj	ICmObject
return	System

CreateNewUiObject() public static method

public static CreateNewUiObject ( XCore.Mediator mediator, int classId, int hvoOwner, int flid, int insertionPosition ) : CmObjectUi
mediator	XCore.Mediator
classId	int
hvoOwner	int
flid	int
insertionPosition	int
return	CmObjectUi

FormatDisplayTextWithListName() public static method

public static FormatDisplayTextWithListName ( SIL.FieldWorks.FDO.FdoCache cache, XCore.Mediator mediator, ICmPossibilityList pssl, XCore.UIItemDisplayProperties &display ) : string
cache	SIL.FieldWorks.FDO.FdoCache
mediator	XCore.Mediator
pssl	ICmPossibilityList
display	XCore.UIItemDisplayProperties
return	string

OnDisplayJumpToTool() public method

public OnDisplayJumpToTool ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject	object
display	XCore.UIItemDisplayProperties
return	bool