FilterController Members
Represents a ViewController descendant that contains the FullTextSearch and SetFilter Actions.Constructors
| Name | Description |
|---|---|
| FilterController() | Creates an instance of the FilterController class. |
Fields
| Name | Description |
|---|---|
| ControllerActiveKey static | 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 static | 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 | Returns 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. |
| AllowFilterNonPersistentObjects | Indicates whether or not the SetFilter and FullTextFilter Actions are active when a current View displays non-persistent objects. |
| Application | Provides access to an XafApplication object that can be used to manage the current application. Inherited from Controller. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| 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. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Tag | Provides access to the object that contains data about the Controller. Inherited from Controller. |
| TargetObjectType | Specifies a ViewController‘s target object type. The View Controller is activated only for Views that represent this type. 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, IServiceProvider) | Clones a Controller. Inherited from Controller. |
| Create(Type, IServiceProvider) static | Instantiates a Controller object of the specified type and raises its 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. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| GetFullTextSearchProperties() | Returns the properties over which the FullTextSearch Action is executed, based on the FilterController.FullTextSearchTargetPropertiesMode property’s value. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| SetView(View) | Sets a specified View for a View Controller. Inherited from ViewController. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
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. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| 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. |
See Also