SearchFieldsHelper.IsIndexField Method

Returns true if field represented by searchSettings is to be included in given index.

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public bool IsIndexField(
	ISearchIndexInfo index,
	SearchSettingsInfo searchSettings
)

Parameters

index

Type: CMS.DataEngine.ISearchIndexInfo
Index for which to detect whether field is an index field. Pass null to detect if field is an index field in any index type.

searchSettings

Type: CMS.DataEngine.SearchSettingsInfo
Search setting representing tested field.

Return Value

Type: Boolean
True if field is an index field, false otherwise.