C# Class SIL.FieldWorks.XWorks.RecordClerk.ListUpdateHelper

This class helps manage multiple changes to a record list. By default, it will suspend full Reloads initiated by PropChanged until we finish. During dispose, we'll ReloadList if we tried to reload the list via PropChanged.
Inheritance: FwDisposableBase
Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method Description
ListUpdateHelper ( RecordClerk clerk ) : System

ListUpdateHelper ( RecordClerk clerk, Control parentForWaitCursor ) : System

ListUpdateHelper ( RecordClerk clerk, ListUpdateHelperOptions options ) : System

Protected Methods

Method Description
DisposeManagedResources ( ) : void
DisposeUnmanagedResources ( ) : void

Private Methods

Method Description
ListUpdateHelper ( RecordClerk clerk, bool fWasAlreadySuppressed ) : System
ListUpdateHelper ( SIL.FieldWorks.XWorks.RecordList list, Control parentForWaitCursor ) : System
ListWasRestored ( ) : void

The list was successfully restored (from a persisted sort sequence). We should NOT sort it when disposed, nor restore an original flag indicating it needed sorting.

Method Details

DisposeManagedResources() protected method

protected DisposeManagedResources ( ) : void
return void

DisposeUnmanagedResources() protected method

protected DisposeUnmanagedResources ( ) : void
return void

ListUpdateHelper() public method

public ListUpdateHelper ( RecordClerk clerk ) : System
clerk RecordClerk clerk we want to suspend reloading for. if null, we don't do anything.
return System

ListUpdateHelper() public method

public ListUpdateHelper ( RecordClerk clerk, Control parentForWaitCursor ) : System
clerk RecordClerk
parentForWaitCursor System.Windows.Forms.Control for wait cursor
return System

ListUpdateHelper() public method

public ListUpdateHelper ( RecordClerk clerk, ListUpdateHelperOptions options ) : System
clerk RecordClerk
options ListUpdateHelperOptions
return System