C# Class SIL.FieldWorks.XWorks.RecordView

RecordView is an abstract class for data views that show one object from a list. A RecordClerk class does most of the work of managing the list and current object. list management and navigation is entirely handled by the RecordClerk. RecordClerk has no knowledge of how to display an individual object. A concrete subclass must handle this task. Concrete subclasses must: 1. Implement IxCoreColleague.Init, which should call InitBase, do any other initialization, and then set m_fullyInitialized. 2. Implement the pane that shows the current object. Typically, set its Dock property to DockStyle.Fill and add it to this.Controls. This is typically done in an override of SetupDataContext. 3. Implement ShowRecord to update the view of the object to a display of Clerk.CurrentObject. Subclasses may: - Override ReadParameters to extract info from the configuration node. (This is the representation of the XML node from the node used to invoke the window.) - Override GetMessageAdditionalTargets to provide message handlers in addition to the record clerk and this.
Inheritance: SIL.FieldWorks.XWorks.XWorksViewBase
Mostrar archivo Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method Description
OnRecordNavigation ( object argument ) : bool
RecordView ( ) : System

Initializes a new instance of the ViewManager class.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

InitBase ( XCore.Mediator mediator, XmlNode configurationParameters ) : void

Initialize this as an IxCoreColleague

subclasses must call this from their Init. This was done, rather than providing an Init() here in the normal way, to drive home the point that the subclass must set m_fullyInitialized to true when it is fully initialized.

PersistSortSequence ( ) : void
SetupDataContext ( ) : void

Note: currently called in the context of ListUpdateHelper, which suspends the clerk from reloading its list until it is disposed. So, don't do anything here (eg. Clerk.SelectedRecordChanged()) that depends upon a list being loaded yet.

ShowRecord ( ) : void

Shows the record.

ShowRecord ( RecordNavigationInfo rni ) : void

Shows the record.

UpdateContextHistory ( ) : void

create and register a URL describing the current context, for use in going backwards and forwards

Private Methods

Method Description
GetClerkPersistPathname ( ) : string
GetSortFilePersistPathname ( SIL.FieldWorks.FDO.FdoCache cache, string clerkId ) : string
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

RestoreSortSequence ( ) : bool
SetTreebarAvailability ( ) : void

Method Details

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged /// resources; false to release only unmanaged resources. ///
return void

InitBase() protected method

Initialize this as an IxCoreColleague
subclasses must call this from their Init. This was done, rather than providing an Init() here in the normal way, to drive home the point that the subclass must set m_fullyInitialized to true when it is fully initialized.
protected InitBase ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
mediator XCore.Mediator
configurationParameters System.Xml.XmlNode
return void

OnRecordNavigation() public method

public OnRecordNavigation ( object argument ) : bool
argument object
return bool

PersistSortSequence() protected method

protected PersistSortSequence ( ) : void
return void

RecordView() public method

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

SetupDataContext() protected method

Note: currently called in the context of ListUpdateHelper, which suspends the clerk from reloading its list until it is disposed. So, don't do anything here (eg. Clerk.SelectedRecordChanged()) that depends upon a list being loaded yet.
protected SetupDataContext ( ) : void
return void

ShowRecord() protected method

Shows the record.
protected ShowRecord ( ) : void
return void

ShowRecord() protected method

Shows the record.
protected ShowRecord ( RecordNavigationInfo rni ) : void
rni RecordNavigationInfo The record navigation info.
return void

UpdateContextHistory() protected method

create and register a URL describing the current context, for use in going backwards and forwards
protected UpdateContextHistory ( ) : void
return void