SearchClassOptionsAttribute.IncludeMembersInCriteria Property

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

Namespace: DevExpress.ExpressApp.Filtering

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public SearchMemberMode IncludeMembersInCriteria { get; }

VB.NET

Public ReadOnly Property IncludeMembersInCriteria As SearchMemberMode

Property Value

Type	Description
SearchMemberMode	The SearchMemberMode enumeration value specifying whether to include or exclude the target class’ properties 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 includeMembersInCriteria parameter passed in the SearchClassOptionsAttribute, applied to a business class. The following values are possible:

• Include

  The search is allowed within all the properties of the target class. So, all the properties that are specified by the FilterController.FullTextSearchTargetPropertiesMode will be used in the search performed by the FullTextSearch Action.

  Note that individual properties will be excluded from the search scope, if they use the SearchMemberOptionsAttribute with the SearchMemberMode.Exclude parameter value.

• Exclude

  The search is not allowed within all the properties of the target class.

  Note that individual properties will be included in the search scope if they use the SearchMemberOptionsAttribute with the SearchMemberMode.Include parameter value, and satisfy the Filter Controller’s FullTextSearchTargetPropertiesMode.