MaxCustomControls::QuickRegexFindHandler Class Reference

---

Detailed Description

Performs searches in an ExplorerControl as the user types the search key.

Supports plain text, regular expression, and wildcard searches.

List of all members.

Classes
class	MatchOperation
	A treelist operation for performing the Regex match.
Public Member Functions
void	SetPatternSource (ToolStripItem source)
	Set the source UI item from which the Pattern text is drawn.
void	SetPatternSource (Control source)
	Set the source UI item from which the Pattern text is drawn.
Control	GetControlPatternSource ()
	Returns the text pattern source - or null if this is not the right source.
ToolStripItem	GetToolStripItemPatternSource ()
	Returns the text pattern source - or null if this is not the right source.
void	ExecuteFind ()
	Performs a search in the MatchedProperty values from the ExplorerControl's nodes, then sets the ExplorerControl's node selection to the search results.
void	HandleTextChanged (Object sender, EventArgs e)
	TextChanged event handler: will automatically execute a Find if user confirmation is not required.
void	HandleEnterKeyEvent (Object sender, KeyEventArgs e)
	Key Event handler: will automatically execute a Find if the key event is an Enter key.
Protected Member Functions
virtual void	OnIsCaseSensitiveChanged (ValueChangedEventArgs< bool > e)
	Raises the IsCaseSensitiveChanged event.
virtual void	OnFindStyleChanged (ValueChangedEventArgs< FindStyle > e)
	Raises the FindStyleChanged event.
Properties
ExplorerControl	ExplorerControl [get, set]
	Searches are performed in this control's data set.
PropertyDescriptor	MatchedProperty [get, set]
	Field searched by this handler.
bool	IsCaseSensitive [get, set]
	Determines if the search should be performed case sensitive.
FindStyle	FindStyleOption [get, set]
	Determines if the handler will use strict, regex or wilcard searching.
bool	RequiresConfirmation [get, set]
	This property can be set to force the user to Confirm the find request via the Enter or Return key.
Events
EventHandler < ValueChangedEventArgs< bool > >	IsCaseSensitiveChanged
	Occurs when IsCaseSensitive is changed.
EventHandler < ValueChangedEventArgs < FindStyle > >	FindStyleChanged
	Occurs when the FindStyleOption property is changed.

---

Member Function Documentation

virtual void MaxCustomControls::QuickRegexFindHandler::OnIsCaseSensitiveChanged

(

ValueChangedEventArgs< bool >

e

)

[inline, protected, virtual]

Raises the IsCaseSensitiveChanged event.

Parameters:

e	The arguments to use - contains the new and old values

virtual void MaxCustomControls::QuickRegexFindHandler::OnFindStyleChanged

(

ValueChangedEventArgs< FindStyle >

e

)

[inline, protected, virtual]

Raises the FindStyleChanged event.

Parameters:

e	The arguments to use - contains the new and old values

void MaxCustomControls::QuickRegexFindHandler::SetPatternSource

(

ToolStripItem

source

)

[inline]

Set the source UI item from which the Pattern text is drawn.

Parameters:

source

The ToolStripItem from which the pattern text is drawn.

void MaxCustomControls::QuickRegexFindHandler::SetPatternSource

(

Control

source

)

[inline]

Set the source UI item from which the Pattern text is drawn.

Parameters:

source

The Control item from which the pattern text is drawn.

Control MaxCustomControls::QuickRegexFindHandler::GetControlPatternSource

(

)

[inline]

Returns the text pattern source - or null if this is not the right source.

Returns:

the text pattern source - or null if this is not the right source

ToolStripItem MaxCustomControls::QuickRegexFindHandler::GetToolStripItemPatternSource

(

)

[inline]

Returns the text pattern source - or null if this is not the right source.

Returns:

the text pattern source - or null if this is not the right source

void MaxCustomControls::QuickRegexFindHandler::ExecuteFind

(

)

[inline]

Performs a search in the MatchedProperty values from the ExplorerControl's nodes, then sets the ExplorerControl's node selection to the search results.

The search is performed in a background thread to enable the user to continue typing.

void MaxCustomControls::QuickRegexFindHandler::HandleTextChanged	(	Object	sender,
		EventArgs	e
	)		[inline]

TextChanged event handler: will automatically execute a Find if user confirmation is not required.

Parameters:

sender	source of the event - the pattern source
e	not used

void MaxCustomControls::QuickRegexFindHandler::HandleEnterKeyEvent	(	Object	sender,
		KeyEventArgs	e
	)		[inline]

Key Event handler: will automatically execute a Find if the key event is an Enter key.

Parameters:

sender	source of the event - the pattern source
e	used to check if this is an Enter key

---

Property Documentation

ExplorerControl MaxCustomControls::QuickRegexFindHandler::ExplorerControl [get, set]

Searches are performed in this control's data set.

PropertyDescriptor MaxCustomControls::QuickRegexFindHandler::MatchedProperty [get, set]

Field searched by this handler.

bool MaxCustomControls::QuickRegexFindHandler::IsCaseSensitive [get, set]

Determines if the search should be performed case sensitive.

This applies to all find styles.

FindStyle MaxCustomControls::QuickRegexFindHandler::FindStyleOption [get, set]

Determines if the handler will use strict, regex or wilcard searching.

FindStyle

bool MaxCustomControls::QuickRegexFindHandler::RequiresConfirmation [get, set]

This property can be set to force the user to Confirm the find request via the Enter or Return key.

---

Event Documentation

EventHandler<ValueChangedEventArgs<bool> > MaxCustomControls::QuickRegexFindHandler::IsCaseSensitiveChanged

Occurs when IsCaseSensitive is changed.

EventHandler<ValueChangedEventArgs<FindStyle> > MaxCustomControls::QuickRegexFindHandler::FindStyleChanged

Occurs when the FindStyleOption property is changed.