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

Helper for handling switching between related (ListItemClass) lists.
Inheritance: SIL.Utils.FwDisposableBase
Show file Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Property Type Description
FindTreeRelationship RelationshipOfRelatives
GetDescendents Set
GetGhostParentHelper GhostParentHelper
GetHvoCommonAncestor int
GetTreeNode System.Xml.XmlNode
PartOwnershipTree System

Public Methods

Method Description
Create ( SIL.FieldWorks.FDO.FdoCache cache, IMultiListSortItemProvider sortItemProvider, bool fReturnFirstDecendentOnly ) : PartOwnershipTree

Factory for returning a PartOwnershipTree
FindCorrespondingItemsInCurrentList ( int flidForItemsBeforeListChange, Set itemsBeforeListChange, int flidForCurrentList, Set &commonAncestors ) : Set

Map itemsBeforeListChange (associated with flidForItemsBeforeListChange) to those in the current list (associated with flidForCurrentList) and provide a set of common ancestors.
GetSourceFieldName ( int targetClsId, int targetFieldId ) : string

Get the field name that should be used for the main record list when we want to edit the specified field of the specified object class. TargetFieldId may be 0 to get the default (or only) main record list field for the specified class.

Protected Methods

Method Description
DisposeUnmanagedResources ( ) : void

Private Methods

Method Description
FindTreeRelationship ( int prevListItemsClass, int newListItemsClass ) : RelationshipOfRelatives
GetDescendents ( int hvoCommonAncestor, int relativesFlid ) : Set
GetGhostParentHelper ( int flidToTry ) : GhostParentHelper
GetHvoCommonAncestor ( int hvoBeforeListChange, int prevListItemsClass, int newListItemsClass ) : int
GetTreeNode ( int classId ) : XmlNode
PartOwnershipTree ( SIL.FieldWorks.FDO.FdoCache cache, IMultiListSortItemProvider sortItemProvider, bool fReturnFirstDecendentOnly ) : System

Method Details

Create() static public method

Factory for returning a PartOwnershipTree
static public Create ( SIL.FieldWorks.FDO.FdoCache cache, IMultiListSortItemProvider sortItemProvider, bool fReturnFirstDecendentOnly ) : PartOwnershipTree
cache SIL.FieldWorks.FDO.FdoCache
sortItemProvider IMultiListSortItemProvider
fReturnFirstDecendentOnly bool
return PartOwnershipTree

DisposeUnmanagedResources() protected method

protected DisposeUnmanagedResources ( ) : void
return void

FindCorrespondingItemsInCurrentList() public method

Map itemsBeforeListChange (associated with flidForItemsBeforeListChange) to those in the current list (associated with flidForCurrentList) and provide a set of common ancestors.
public FindCorrespondingItemsInCurrentList ( int flidForItemsBeforeListChange, Set itemsBeforeListChange, int flidForCurrentList, Set &commonAncestors ) : Set
flidForItemsBeforeListChange int
itemsBeforeListChange Set
flidForCurrentList int
commonAncestors Set
return Set

GetSourceFieldName() public method

Get the field name that should be used for the main record list when we want to edit the specified field of the specified object class. TargetFieldId may be 0 to get the default (or only) main record list field for the specified class.
public GetSourceFieldName ( int targetClsId, int targetFieldId ) : string
targetClsId int
targetFieldId int
return string