C# Class SIL.FieldWorks.XWorks.RecordClerk

Tell the RecordClerk that it may now be the new master of the tree bar, if it is not a dependent clerk. Use DeactivatedGui to tell RecordClerk that it's not currently being used in a Gui.

Test to see if the two given sorters are compatible, override if you need to check for something beyond what the RecordSorter.CompatibleSorter() will test.

Tell RecordClerk that we're not currently being used in a Gui.

Called at the start of broadcasting PropChanged messages, passed the count of changes. Currently this used so as to not doing anything to batch them if there is only one.

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

Must not be virtual.

Called after broadcasting all changes.

finds an existing RecordClerk by the given id.

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

Initialize the IxCoreColleague

Jump to the specified index in the list.

Jump to the specified object.

If we're wrapping a ConcDecorator, we can extract its AnalysisOccurrence.

Make Filters menuBar item selection adjustments as necessary.

Figure a tooltop for the DeleteRecord command.

see if it makes sense to provide the "delete record" command now

this is called when XCore wants to display something that relies on the list with the id "FiltersList"

see if it makes sense to provide the "previous record" command now

Influence the display of a particular *command* (which we don't know the name of) by giving an opinion on whether we are prepared to handle its corresponding "InsertItemInVector" *message*.

see if it makes sense to provide the "next record" command now

see if it makes sense to provide the "next record" command now

see if it makes sense to provide the "previous record" command now

this is triggered by any command whose message attribute is "InsertItemInVector"

This is invoked by reflection when something might want to know about a change. The initial usage is for the respelling dialog to let ConcDecorators know about spelling changes. The notification is passed on to any SDAs that understand it, including embedded ones.

display the given record

move to the next or last record in the current set of records

Receives the broadcast message "PropertyChanged"

Called when the sorter changes. A name indicating what is being sorted is passed along with the record sorter.

We watch for changes to DateModified and update the status bar if we are controlling it.

refresh current record, by deleting and re-inserting it into our list.

This is public for now just so MatchingReversalEntriesBrowser.Initialize can call it, but I (JohnT) haven't yet fully determined whether it needs to. I just needed to stop it being called in another, much more common context, so moved a call there.

deletes invalidated sort items from the list. (e.g. as result from Undo/Redo).

deletes the given item from the list. needed to fix LT-9230 without full reload.

This method is called by views that display a single record to cause a Save when switching records. The purpose is to allow the special Save to be suppressed in certain cases, such as Delete record (and perhaps eventually create record).

update the status bar, selected node of the tree bar, etc. and broadcast record navigation

update the status bar, selected node of the tree bar, etc.

Very like UpdateOwningObject, but needs to be internal, and don't want to do anything (like reloading list) if it didn't change.

If the record bar is visible and needs to be repopulated, do it.

Called by a view (e.g. browseView) when, internally, it changes the currently selected record.

Override this (initially only in InterlinTextsRecordClerk) if the clerk knows how to add an item to the current list/filter on request.

Override this if there are special cases where you need more control over which objects can be deleted.

A hook to allow a subclass to remove an invalid subitem.

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.

By default DeleteRecord deletes the current record. Override if you need to delete something else. For example, in interlinear text we delete the owning Text.

determine if we're in the (given) area

determine if we're in the (given) tool

update the contents of the filter list.

update the contents of the tree bar and anything else that should change when, for example, the filter or sort order changes.

Handles refreshing the record list after an object was deleted.

This should be overriden to perform more efficient refreshing of the record list display

By default we just silently don't delete things that shouldn't be. Override if you want to give a message.

Figure out what should show in the filter status panel and make it so.

Compares the state of the filters and sorters to persisted values in property table and re-establishes them from the property table if they have changed.

Find the index of hvoTarget in m_list; or, if it does not occur, the index of a child of hvoTarget.

Change the list filter to the currently selected (checked) FilterList item. This selection is stored in the property table based on the name of the filter associated with the current clerk.

Handle a change to the class of items we want to bulk edit (and sometimes the field we want to bulk edit matters, too).

returns the Clerk that governs the OwningObject of our clerk.

Persist this list for retrieval by RestoreListFrom, if we are a primary Clerk.

Stop notifications of prop changes

If a filter becomes invalid, it has to be reset somehow. This resets it to the default filter for this clerk (possibly null).

Returns true if successful, false if some problem reading the file, including detecting that part of a key is a deleted object. Return false if this is not the primary clerk.

Overridden in SubitemRecordClerk, this records the subitem.

Update the list, and possibly the record referenced by our stored IRecordChangeHandler object.

Part of the IRecordListUpdater interface.