C# Класс SIL.FieldWorks.XWorks.LinkListener

Наследование: IxCoreColleague, IFWDisposable
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
m_backStack LinkedList
m_currentContext FwLinkArgs
m_forwardStack LinkedList
m_mediator XCore.Mediator

Открытые методы

Метод Описание
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

Защищенные методы

Метод Описание
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.

Приватные методы

Метод Описание
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

Описание методов

CheckDisposed() публичный Метод

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
public CheckDisposed ( ) : void
Результат void

Dispose() публичный Метод

Must not be virtual.
public Dispose ( ) : void
Результат void

Dispose() защищенный Метод

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
Результат void

GetMessageTargets() публичный Метод

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[]
Результат IxCoreColleague[]

Init() публичный Метод

public Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
mediator XCore.Mediator
configurationParameters System.Xml.XmlNode
Результат void

LinkListener() публичный Метод

Initializes a new instance of the LinkListener class.
public LinkListener ( ) : System
Результат System

OnAddContextToHistory() публичный Метод

public OnAddContextToHistory ( object _link ) : bool
_link object
Результат bool

OnCopyLocationAsHyperlink() публичный Метод

public OnCopyLocationAsHyperlink ( object unused ) : bool
unused object
Результат bool

OnDisplayHistoryBack() публичный Метод

public OnDisplayHistoryBack ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject object
display XCore.UIItemDisplayProperties
Результат bool

OnDisplayHistoryForward() публичный Метод

public OnDisplayHistoryForward ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject object
display XCore.UIItemDisplayProperties
Результат bool

OnFollowLink() публичный Метод

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
Результат bool

OnHandleLocalHotlink() публичный Метод

Handle the specified link if it is local.
public OnHandleLocalHotlink ( object source ) : bool
source object
Результат bool

OnHistoryBack() публичный Метод

public OnHistoryBack ( object unused ) : bool
unused object
Результат bool

OnHistoryForward() публичный Метод

public OnHistoryForward ( object unused ) : bool
unused object
Результат bool

OnTestFollowLink() публичный Метод

public OnTestFollowLink ( object unused ) : bool
unused object
Результат bool

Описание свойств

m_backStack защищенное свойство

protected LinkedList m_backStack
Результат LinkedList

m_currentContext защищенное свойство

protected FwLinkArgs m_currentContext
Результат FwLinkArgs

m_forwardStack защищенное свойство

protected LinkedList m_forwardStack
Результат LinkedList

m_mediator защищенное свойство

protected Mediator,XCore m_mediator
Результат XCore.Mediator