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.v19.2.dll

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 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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomGetFullTextSearchProperties event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-make-the-filterbytext-action-search-within-required-properties-e231/CS/HowToChangeFilterByTextAction.Module/MyFilterController.cs#L24

if(standardFilterController != null) {
    standardFilterController.CustomGetFullTextSearchProperties += new EventHandler<CustomGetFullTextSearchPropertiesEventArgs>(standardFilterController_CustomGetFullTextSearchProperties);
}

VB.NET

XAF_how-to-make-the-filterbytext-action-search-within-required-properties-e231/VB/HowToChangeFilterByTextAction.Module/MyFilterController.vb#L26

If standardFilterController IsNot Nothing Then
    AddHandler standardFilterController.CustomGetFullTextSearchProperties, AddressOf standardFilterController_CustomGetFullTextSearchProperties
End If