C# Class SIL.FieldWorks.FdoUi.ReferenceBaseUi

This is the base class for handling references.

Inheritance: CmObjectUi

Exibir arquivo Open project: sillsdev/FieldWorks

Protected Properties

Property	Type	Description
m_flid	int
m_hvoTarget	int
m_targetUi	CmObjectUi

Public Methods

Method	Description
MakeUi ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject rootObj, int referenceFlid, int targetHvo ) : ReferenceBaseUi	This is the ReferenceUi factory. We currently exclude ReferenceSequenceUi (see that class for reason).
OnDisplayJumpToTool ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
OnDisplayMoveTargetDownInSequence ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool	Overriden by ReferenceSequenceUi.
OnDisplayMoveTargetUpInSequence ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool	Overridden by ReferenceSequenceUi. We put these OnDisplayMove... routines in the base class, so that we can make them explicitly not show up for non ReferenceSequence classes. Otherwise, they might appear as disabled for commands under mnuReferenceChoices.
OnJumpToTool ( object commandObject ) : bool	JohnT: Transferred this from FW 6 but don't really understand what it's all about. The overridden method is about various "Show X in Y" commands.
ReferenceBaseUi ( ) : System
ReferenceBaseUi ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject rootObj, int referenceFlid, int targetHvo ) : System
ReferenceBaseUi ( ICmObject rootObj ) : System

Method Details

MakeUi() static public method

This is the ReferenceUi factory. We currently exclude ReferenceSequenceUi (see that class for reason).

static public MakeUi ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject rootObj, int referenceFlid, int targetHvo ) : ReferenceBaseUi
cache	SIL.FieldWorks.FDO.FdoCache
rootObj	ICmObject
referenceFlid	int
targetHvo	int
return	ReferenceBaseUi

OnDisplayJumpToTool() public method

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

OnDisplayMoveTargetDownInSequence() public method

Overriden by ReferenceSequenceUi.

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

OnDisplayMoveTargetUpInSequence() public method

Overridden by ReferenceSequenceUi. We put these OnDisplayMove... routines in the base class, so that we can make them explicitly not show up for non ReferenceSequence classes. Otherwise, they might appear as disabled for commands under mnuReferenceChoices.

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

OnJumpToTool() public method

JohnT: Transferred this from FW 6 but don't really understand what it's all about. The overridden method is about various "Show X in Y" commands.

public OnJumpToTool ( object commandObject ) : bool
commandObject	object
return	bool

ReferenceBaseUi() public method

public ReferenceBaseUi ( ) : System
return	System

ReferenceBaseUi() public method

public ReferenceBaseUi ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject rootObj, int referenceFlid, int targetHvo ) : System
cache	SIL.FieldWorks.FDO.FdoCache
rootObj	ICmObject
referenceFlid	int
targetHvo	int
return	System

ReferenceBaseUi() public method

public ReferenceBaseUi ( ICmObject rootObj ) : System
rootObj	ICmObject
return	System

Property Details

m_flid protected_oe property

protected int m_flid
return	int

m_hvoTarget protected_oe property

protected int m_hvoTarget
return	int

m_targetUi protected_oe property

protected CmObjectUi,SIL.FieldWorks.FdoUi m_targetUi
return	CmObjectUi