FilterController Members

Constructors

Name Description
FilterController()

Creates an instance of the FilterController class.

Fields

Name Description
ControllerActiveKey

Specifies one of the keys from the ActionBase.Active collection of a Controller's Controller.Actions. By default, this field value is "Controller active". You can use this field when working with the ActionBase.Active collection.

(Inherited from Controller)
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.

ViewIsAssignedReason

Specifies the Controller.Active list's reason that indicates whether a View is assigned to the current ViewController.

(Inherited from ViewController)

Properties

Name Description
Actions

Provides access to a Controller's Action collection.

(Inherited from Controller)
Active

Provides access to a collection of reason/value pairs used to activate or deactivate a Controller, or determine its active state.

(Inherited from Controller)
Application

Provides access to an XafApplication object that can be used to manage the current application.

(Inherited from Controller)
Frame

Provides access to a Controller's Frame.

(Inherited from Controller)
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.

Name

Returns a full name of a Controller's type.

(Inherited from Controller)
SetFilterAction

Provides access to the ModificationsController's SetFilter Action.

Tag

Provides access to the object that contains data about the Controller.

(Inherited from Controller)
TargetObjectType

Specifies the type of objects that must be represented by a View to provide View Controller activation.

(Inherited from ViewController)
TargetViewId

Specifies the identifier of the View for which the View Controller is activated, or a semicolon-separated list of identifiers if a View Controller targets multiple Views.

(Inherited from ViewController)
TargetViewNesting

Specifies whether the View for which a View Controller is intended must be root, nested or any.

(Inherited from ViewController)
TargetViewType

Specifies the type of the View, for which a View Controller is intended.

(Inherited from ViewController)
TypeOfView

Specifies the type of the View, for which a View Controller is intended.

(Inherited from ViewController)
View

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

Methods

Name Description
Clone(IModelApplication)

Clones a Controller.

(Inherited from Controller)
Create(Type)

Instantiates a Controller object of the specified type and raises it's Controller.AfterConstruction event.

(Inherited from Controller)
CustomizeTypesInfo(ITypesInfo)

Customizes business class metadata before loading it to the Application Model's BOModel node.

(Inherited from Controller)
GetFullTextSearchProperties()

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

SetView(View)

Sets a specified View for a View Controller.

(Inherited from ViewController)

Events

Name Description
Activated

Occurs when a Controller is activated.

(Inherited from Controller)
AfterConstruction

Occurs after a Controller is created.

(Inherited from Controller)
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
Deactivated

Occurs after a Controller has been deactivated.

(Inherited from Controller)
FrameAssigned

Occurs after a Frame (Window) has been assigned to a Controller.

(Inherited from Controller)
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.

ViewControlsCreated

Occurs after the controls have been created for the current Controller's ViewController.View if the Controller has already been activated.

(Inherited from ViewController)
ViewControlsDestroying

For internal use only.

(Inherited from ViewController)