C# Class SIL.FieldWorks.XWorks.RecordBarHandler

Responsible for populating the XCore tree bar with the records.

Inheritance: IFWDisposable

Afficher le fichier Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Свойство	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

Méthodes publiques

Méthode	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

Méthodes protégées

Méthode	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

Méthode	Description
Init ( XCore.Mediator mediator, XmlNode node ) : void

Method Details

CheckDisposed() public méthode

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

public CheckDisposed ( ) : void
Résultat	void

Create() static public méthode

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

Dispose() public méthode

Must not be virtual.

public Dispose ( ) : void
Résultat	void

Dispose() protected méthode

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
Résultat	void

PopulateRecordBar() public abstract méthode

public abstract PopulateRecordBar ( SIL.FieldWorks.XWorks.RecordList list ) : void
list	SIL.FieldWorks.XWorks.RecordList
Résultat	void

PopulateRecordBarIfNeeded() public méthode

public PopulateRecordBarIfNeeded ( SIL.FieldWorks.XWorks.RecordList list ) : void
list	SIL.FieldWorks.XWorks.RecordList
Résultat	void

ReleaseRecordBar() public abstract méthode

public abstract ReleaseRecordBar ( ) : void
Résultat	void

ReloadItem() public abstract méthode

public abstract ReloadItem ( ICmObject currentObject ) : void
currentObject	ICmObject
Résultat	void

ShouldAddNode() protected méthode

protected ShouldAddNode ( ICmObject obj ) : bool
obj	ICmObject
Résultat	bool

UpdateSelection() public abstract méthode

public abstract UpdateSelection ( ICmObject currentObject ) : void
currentObject	ICmObject
Résultat	void

Property Details

m_bestWS protected_oe property

protected string m_bestWS
Résultat	string

m_cache protected_oe property

protected FdoCache,SIL.FieldWorks.FDO m_cache
Résultat	SIL.FieldWorks.FDO.FdoCache

m_expand protected_oe property

protected bool m_expand
Résultat	bool

m_fOutOfDate protected_oe property

protected bool m_fOutOfDate
Résultat	bool

m_hierarchical protected_oe property

protected bool m_hierarchical
Résultat	bool

m_includeAbbr protected_oe property

protected bool m_includeAbbr
Résultat	bool

m_mediator protected_oe property

protected Mediator,XCore m_mediator
Résultat	XCore.Mediator