SearchMemberOptionsAttribute.IncludeMemberInCriteria Property

Indicates whether to include or exclude the target property from the search performed by the FullTextSearch Action (see FilterController.FullTextFilterAction).

Namespace: DevExpress.ExpressApp.Filtering

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public SearchMemberMode IncludeMemberInCriteria { get; }

VB.NET

Public ReadOnly Property IncludeMemberInCriteria As SearchMemberMode

Property Value

Type	Description
SearchMemberMode	The SearchMemberMode enumeration value specifying whether to include or exclude the target property from the search performed by the FullTextSearch Action.

Available values:

Name	Description
Unknown	When used by the SearchClassOptionsAttribute, properties of the target class that can be used in the search performed by the FullTextSearch Action are unspecified.
Include	When used by the SearchClassOptionsAttribute, specifies that all the properties of the target class can be used in the search performed by the FullTextSearch Action, if they satisfy the Filter Controller’s FilterController.FullTextSearchTargetPropertiesMode. When used by the SearchMemberOptionsAttribute, specifies that the target property can be used in the search performed by the FullTextSearch Action.
Exclude	When used by the SearchClassOptionsAttribute, specifies that none of the properties of the target class can be used in the search performed by the FullTextSearch Action, if they satisfy the Filter Controller’s FilterController.FullTextSearchTargetPropertiesMode. When used by the SearchMemberOptionsAttribute, specifies whether the target property cannot be used in the search performed by the FullTextSearch Action.

Remarks

This property is specified by the useMemberInCriteria parameter passed as the SearchMemberOptions attribute, applied to a business class property. The following values are possible:

• Include

  The target property is allowed to be used in the search performed by the FullTextSearch Action.

• Exclude

  The target property is prohibited from use in the search performed by the FullTextSearch Action.