FilterController.FullTextSearchTargetPropertiesMode Property

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

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v18.1.dll

Syntax

public FullTextSearchTargetPropertiesMode FullTextSearchTargetPropertiesMode { get; set; }

Returns

Type Description
FullTextSearchTargetPropertiesMode

A FullTextSearchTargetPropertiesMode enumeration value that specifies the way in which the FullTextSearch Action collects properties for the criterion to be generated. The default value depends on the kind of List View for which the FilterController was activated. For the List Views used by the Lookup Property Editors, the default value is VisibleColumns. For all the other List Views, the default value is AllSearchableMembers.

When the FullTextSearchTargetPropertiesMode property is set to VisibleColumns, the FullTextSearch Action performs its search over the properties whose corresponding columns are visible.

Note

The FullTextSearch Action always performs a search over the Friendly Key property, even if the FullTextSearchTargetPropertiesMode.VisibleColumns mode is specified and Friendly Key column is hidden. The Friendly Key property is a business class property specified via the FriendlyKeyPropertyAttribute or via the IModelClass.FriendlyKeyProperty option in the Application Model.

When the FullTextSearchTargetPropertiesMode property is set to AllSearchableMembers, the FullTextSearch Action performs its search over the following properties:

  • Any property of the current object
  • Any property of the aggregated object
  • The default property of the referenced object
  • The properties that are presented by visible columns in the current List View

Note that if the current List View uses Server mode (has its Application Model's IModelListView.DataAccessMode property set to server), non-persistent properties are excluded from searchable properties.

Some properties that are added to the search because they satisfy the currently set FullTextSearchTargetPropertiesMode can be excluded, if they use the SearchMemberOptionsAttribute with the SearchMemberMode.Exclude parameter value, or the SearchClassOptionsAttribute with the SearchMemberMode.Exclude parameter value, applied to the entire class.

If you need to manually specify a set of properties to be included in search criteria, handle the FilterController.CustomGetFullTextSearchProperties event.

See Also