FilterController.CustomGetFullTextSearchProperties Event
Occurs when the FullTextSearch Action is executed. Allows you to specify the properties over which the search is performed.
Namespace: DevExpress.ExpressApp.SystemModule
Assembly: DevExpress.ExpressApp.v23.2.dll
NuGet Package: DevExpress.ExpressApp
Declaration
Event Data
The CustomGetFullTextSearchProperties event's data class is CustomGetFullTextSearchPropertiesEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Handled | Gets or sets a value that indicates whether the event handler has completely handled the event or whether the system should continue its own processing. Inherited from HandledEventArgs. |
| Properties | Provides access to a list of the names of the properties over which the FullTextSearch Action performs its search. |
Remarks
The FullTextSearch Action searches the current List View for the objects whose property string representations include the value specified by a user. By default, the FullTextSearch Action performs a search based on the FilterController.FullTextSearchTargetPropertiesMode property value. To override this behavior, handle the CustomGetFullTextSearchProperties event. In the event handler, pass a list of the required property names as the Properties parameter. Set the Handled argument to true, to indicate that the FullTextSearchTargetPropertiesMode property’s value must not be considered. To determine the properties over which the search will be performed by default, use the FilterController.GetFullTextSearchProperties method.
Note, that if you handle the FilterController.CustomBuildCriteria event and set the handler’s Handled parameter to true, the CustomGetFullTextSearchProperties event is not triggered.
To learn about the Filter by Text Action, refer to the FilterController.FullTextFilterAction property description.