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.v25.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<CustomGetFullTextSearchPropertiesEventArgs> CustomGetFullTextSearchProperties

VB.NET

Public Event CustomGetFullTextSearchProperties As EventHandler(Of CustomGetFullTextSearchPropertiesEventArgs)

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 objects where property string representations include the value specified by a user.

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 properties used in default search operations, use the FilterController.GetFullTextSearchProperties method.

Note

If you handle the FilterController.CustomBuildCriteria event and set the handler’s Handled parameter to true, the CustomGetFullTextSearchProperties event is not triggered.

For more information about the Filter by Text Action, refer to the FilterController.FullTextFilterAction property description.

Tip

The FullTextSearch Action is also available in List Views used by Lookup Property Editors. To enable Search mode, use either of the following approaches:

• Specify the IModelClass.DefaultLookupEditorMode option in Model Editor.
• Apply a LookupEditorModeAttribute to the property.