C# Class SIL.FieldWorks.Common.FwUtils.SearchTimer

Inheritance: IDisposable

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
Dispose ( ) : void
OnSearchTextChanged ( object sender, EventArgs e ) : void	This handler should be hooked up to the text box TextChanged event. When the user types in the text box, this arranges to call the original delegate method (from the constructor) that does the searching.
SearchTimer ( Control owningControl, int interval, Searcher searcher ) : System	Creates a SearchTimer.
SearchTimer ( Control owningControl, int interval, Searcher searcher, List controlsToDisable ) : System	Creates a SearchTimer.

Protected Methods

Method	Description
Dispose ( bool fDisposing ) : void
TimerEventProcessor ( object sender, EventArgs eventArgs ) : void	When the timer interval elapses, this method runs the search function.

Private Methods

Method	Description
DisableControls ( ) : void
EnableControls ( ) : void

Method Details

Dispose() public method

public Dispose ( ) : void
return	void

Dispose() protected method

protected Dispose ( bool fDisposing ) : void
fDisposing	bool
return	void

OnSearchTextChanged() public method

This handler should be hooked up to the text box TextChanged event. When the user types in the text box, this arranges to call the original delegate method (from the constructor) that does the searching.

public OnSearchTextChanged ( object sender, EventArgs e ) : void
sender	object
e	System.EventArgs
return	void

SearchTimer() public method

Creates a SearchTimer.

public SearchTimer ( Control owningControl, int interval, Searcher searcher ) : System
owningControl	System.Windows.Forms.Control	This control's cursor will be changed to WaitCursor while searching.
interval	int	Number of milliseconds to pause after user input before starting a search.
searcher	Searcher	The delegate that will do the searching.
return	System

SearchTimer() public method

Creates a SearchTimer.

public SearchTimer ( Control owningControl, int interval, Searcher searcher, List controlsToDisable ) : System
owningControl	System.Windows.Forms.Control	This control's cursor will be changed to WaitCursor while searching.
interval	int	Number of milliseconds to pause after user input before starting a search.
searcher	Searcher	The delegate that will do the searching.
controlsToDisable	List	These controls will be disabled while the search is in progress.
return	System

TimerEventProcessor() protected method

When the timer interval elapses, this method runs the search function.

protected TimerEventProcessor ( object sender, EventArgs eventArgs ) : void
sender	object
eventArgs	System.EventArgs
return	void