C# Class SIL.FieldWorks.XWorks.LinkListener

Inheritance: IxCoreColleague, IFWDisposable
Mostrar archivo Open project: sillsdev/FieldWorks

Protected Properties

Property Type Description
m_backStack LinkedList
m_currentContext FwLinkArgs
m_forwardStack LinkedList
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.
Dispose ( ) : void

Must not be virtual.

GetMessageTargets ( ) : IxCoreColleague[]

return an array of all of the objects which should 1) be queried when looking for someone to deliver a message to 2) be potential recipients of a broadcast
Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
LinkListener ( ) : System

Initializes a new instance of the LinkListener class.
OnAddContextToHistory ( object _link ) : bool

OnCopyLocationAsHyperlink ( object unused ) : bool

OnDisplayHistoryBack ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool

OnDisplayHistoryForward ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool

OnFollowLink ( object lnk ) : bool

NOTE: This will not handle link requests for other databases/applications. To handle other databases or applications, pass a FwAppArgs to the IFieldWorksManager.HandleLinkRequest method.
OnHandleLocalHotlink ( object source ) : bool

Handle the specified link if it is local.
OnHistoryBack ( object unused ) : bool

OnHistoryForward ( object unused ) : bool

OnTestFollowLink ( object unused ) : bool

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.

Private Methods

Method Description
ActiveFlexWindow ( ) : Form
FollowActiveLink ( ) : bool
GetObjectToShowInTool ( ICmObject start ) : ICmObject

Get the object we want to point our tool at. This is typically the one that is one level down from a CmMajorObject.
Pop ( LinkedList stack ) : FwLinkArgs
Push ( LinkedList stack, FwLinkArgs context ) : void
SameDatabase ( FwAppArgs fwargs, SIL.FieldWorks.FDO.FdoCache cache ) : bool
SameServer ( FwAppArgs fwargs, SIL.FieldWorks.FDO.FdoCache cache ) : bool
ShowCantJumpMessage ( string msg ) : 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

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

GetMessageTargets() public method

return an array of all of the objects which should 1) be queried when looking for someone to deliver a message to 2) be potential recipients of a broadcast
public GetMessageTargets ( ) : IxCoreColleague[]
return IxCoreColleague[]

Init() public method

public Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
mediator XCore.Mediator
configurationParameters System.Xml.XmlNode
return void

LinkListener() public method

Initializes a new instance of the LinkListener class.
public LinkListener ( ) : System
return System

OnAddContextToHistory() public method

public OnAddContextToHistory ( object _link ) : bool
_link object
return bool

OnCopyLocationAsHyperlink() public method

public OnCopyLocationAsHyperlink ( object unused ) : bool
unused object
return bool

OnDisplayHistoryBack() public method

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

OnDisplayHistoryForward() public method

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

OnFollowLink() public method

NOTE: This will not handle link requests for other databases/applications. To handle other databases or applications, pass a FwAppArgs to the IFieldWorksManager.HandleLinkRequest method.
public OnFollowLink ( object lnk ) : bool
lnk object
return bool

OnHandleLocalHotlink() public method

Handle the specified link if it is local.
public OnHandleLocalHotlink ( object source ) : bool
source object
return bool

OnHistoryBack() public method

public OnHistoryBack ( object unused ) : bool
unused object
return bool

OnHistoryForward() public method

public OnHistoryForward ( object unused ) : bool
unused object
return bool

OnTestFollowLink() public method

public OnTestFollowLink ( object unused ) : bool
unused object
return bool

Property Details

m_backStack protected_oe property

protected LinkedList m_backStack
return LinkedList

m_currentContext protected_oe property

protected FwLinkArgs m_currentContext
return FwLinkArgs

m_forwardStack protected_oe property

protected LinkedList m_forwardStack
return LinkedList

m_mediator protected_oe property

protected Mediator,XCore m_mediator
return XCore.Mediator