FilterController Members

Constructors

Name Description
FilterController()

Creates an instance of the FilterController class.

Fields

Name Description
FilterCriteriaName

Returns the name of the item in the Criteria collection of the current List View's CollectionSource. This item is updated each time a new filter is selected via the FilterController's Filter Action. By default, this attribute is called "ListViewFilter".

FullTextSearchActionId

Holds the FilterController.FullTextFilterAction's identifier.

FullTextSearchCriteriaName

When the FilterController.FullTextFilterAction is used to filter a List View, a criterion is passes to the CollectionSourceBase.Criteria dictionary of the List View's Collection Source. This dictionary requires that each criterion must be accompanied by a description. The FullTextSearchCriteriaName constant holds a description of criterions passed to the CollectionSourceBase.Criteria dictionary by the FullTextFilterAction.

Properties

Name Description
FullTextFilterAction

Provides access to the FilterController's FullTextSearch Action.

FullTextSearchMode

Specifies the way in which the FullTextSearch Actions performs its search.

FullTextSearchTargetPropertiesMode

Specifies the way in which the FullTextSearch Action collects properties to be included in search criteria.

SetFilterAction

Provides access to the ModificationsController's SetFilter Action.

View

Provides access to the current List View for which the FilterController is activated.

Methods

Name Description
GetFullTextSearchProperties()

Returns the properties over which the FullTextSearch Action is executed, based on the FilterController.FullTextSearchTargetPropertiesMode property's value.

Events

Name Description
CreateCustomSearchCriteriaBuilder

Occurs when the Search Criteria Builder object used to build a criteria expression based on the value passed to the FilterController.FullTextFilterAction is created.

CustomBuildCriteria

Occurs when the FullTextSearch Action is executed. Allows you to create a custom CriteriaOperator that will be used by the FullTextSearch Action, to filter the current List View.

CustomGetFilters

Occurs when the FilterController is activated. Allows you to specify the Application Model's Views | <ListView> | Filters node, containing the filter definitions to be used by the FilterController's SetFilter Action for the currently processed List View.

CustomGetFullTextSearchProperties

Occurs when the FullTextSearch Action is executed. Allows you to specify the properties over which the search is performed.

CustomizeSetFilterActionToolTip
SetFilterActionRefreshed

Occurs after the Application Model's Filters node settings (the list of filters and the selected filter item) are applied to the FilterController.SetFilterAction and before the current filter is applied to the List View's collection source.