C# Class SIL.FieldWorks.XWorks.RecordBarHandler

Responsible for populating the XCore tree bar with the records.

Inheritance: IFWDisposable

显示文件 Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property	Type	Description
m_bestWS	string
m_cache	SIL.FieldWorks.FDO.FdoCache
m_expand	bool
m_fOutOfDate	bool
m_hierarchical	bool
m_includeAbbr	bool
m_mediator	XCore.Mediator

Public Methods

Method	Description
CheckDisposed ( ) : void	Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
Create ( XCore.Mediator mediator, XmlNode toolConfiguration ) : RecordBarHandler
Dispose ( ) : void	Must not be virtual.
PopulateRecordBar ( SIL.FieldWorks.XWorks.RecordList list ) : void
PopulateRecordBarIfNeeded ( SIL.FieldWorks.XWorks.RecordList list ) : void
ReleaseRecordBar ( ) : void
ReloadItem ( ICmObject currentObject ) : void
UpdateSelection ( ICmObject currentObject ) : 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.
ShouldAddNode ( ICmObject obj ) : bool

Private Methods

Method	Description
Init ( XCore.Mediator mediator, XmlNode node ) : void

Method Details

CheckDisposed() public method

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

public CheckDisposed ( ) : void
return	void

Create() static public method

static public Create ( XCore.Mediator mediator, XmlNode toolConfiguration ) : RecordBarHandler
mediator	XCore.Mediator
toolConfiguration	System.Xml.XmlNode
return	RecordBarHandler

Dispose() public method

Must not be virtual.

public Dispose ( ) : void
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

PopulateRecordBar() public abstract method

public abstract PopulateRecordBar ( SIL.FieldWorks.XWorks.RecordList list ) : void
list	SIL.FieldWorks.XWorks.RecordList
return	void

PopulateRecordBarIfNeeded() public method

public PopulateRecordBarIfNeeded ( SIL.FieldWorks.XWorks.RecordList list ) : void
list	SIL.FieldWorks.XWorks.RecordList
return	void

ReleaseRecordBar() public abstract method

public abstract ReleaseRecordBar ( ) : void
return	void

ReloadItem() public abstract method

public abstract ReloadItem ( ICmObject currentObject ) : void
currentObject	ICmObject
return	void

ShouldAddNode() protected method

protected ShouldAddNode ( ICmObject obj ) : bool
obj	ICmObject
return	bool

UpdateSelection() public abstract method

public abstract UpdateSelection ( ICmObject currentObject ) : void
currentObject	ICmObject
return	void

Property Details

m_bestWS protected_oe property

protected string m_bestWS
return	string

m_cache protected_oe property

protected FdoCache,SIL.FieldWorks.FDO m_cache
return	SIL.FieldWorks.FDO.FdoCache

m_expand protected_oe property

protected bool m_expand
return	bool

m_fOutOfDate protected_oe property

protected bool m_fOutOfDate
return	bool

m_hierarchical protected_oe property

protected bool m_hierarchical
return	bool

m_includeAbbr protected_oe property

protected bool m_includeAbbr
return	bool

m_mediator protected_oe property

protected Mediator,XCore m_mediator
return	XCore.Mediator