MaxCustomControls::FilterDescriptionRegistry Class Reference

---

Detailed Description

The class FilterDescriptionRegistry provides detailed description for each filter within a filter list.

Each filter is related with a specific filter key.

FilterDescriptionRegistry serves for the following purpose: 1.To perform the query for a filter description by a specified filter key. 2.To provide a user with the whole filter list. 3.To provide an UI control that performs the filter task with the specific initiation info,which the control required for each filter of the filter list.

Inheritance diagram for MaxCustomControls::FilterDescriptionRegistry:

List of all members.

Public Member Functions
FilterDescription	GetFilterDescriptionByKey (object key)
	Get a filter description according to the filter key.
IEnumerator< KeyValuePair < object, FilterDescription > >	GetEnumerator ()
	Gets an enumerator that iterates through the FilterDescription Dictionary.
Protected Member Functions
void	AddFilterDescription (object key, FilterDescription filterDescription)
	Returns the mFilterDescriptionDictionary member.
Properties
ICollection< IFilterItem >	AllFilters [get]
	Get all filters inside this registry.

---

Member Function Documentation

FilterDescription MaxCustomControls::FilterDescriptionRegistry::GetFilterDescriptionByKey

(

object

key

)

[inline]

Get a filter description according to the filter key.

Parameters:

key	The filter key.

Returns:

Returns the filter description to the key if the key exists. Otherwise,returns null.

IEnumerator<KeyValuePair<object, FilterDescription> > MaxCustomControls::FilterDescriptionRegistry::GetEnumerator

(

)

[inline]

Gets an enumerator that iterates through the FilterDescription Dictionary.

Returns:

The resultant enumerator

void MaxCustomControls::FilterDescriptionRegistry::AddFilterDescription	(	object	key,
		FilterDescription	filterDescription
	)		[inline, protected]

Returns the mFilterDescriptionDictionary member.

---

Property Documentation

ICollection<IFilterItem> MaxCustomControls::FilterDescriptionRegistry::AllFilters [get]

Get all filters inside this registry.