SearchFields.Add Method (String, Boolean, Boolean, Func<Object>, Boolean, Nullable<SearchAnalyzerTypeEnum>)

Adds new field to collection. When field already exists, it will be updated (merged with existing one). When adding content field with it's value multiple times, the value is appended to existing content.

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 10.0.0

Syntax

public virtual ISearchField Add(
	string fieldName,
	bool searchable,
	bool tokenized,
	Func<Object> getValueFunc,
	bool insertDirectly = false,
	Nullable<SearchAnalyzerTypeEnum> analyzer = null
)

Parameters

fieldName

Type: System.String
Field name

searchable

Type: System.Boolean
Indicates if field can be searched

tokenized

Type: System.Boolean
Indicates if field will be tokenized

getValueFunc

Type: System.Func<Object>
Function that returns value of the field

insertDirectly (Optional)

Type: System.Boolean
Indicates if field should be insert directly into search document without additional processing

analyzer (Optional)

Type: System.Nullable<SearchAnalyzerTypeEnum>
Explicit analyzer to process search field's value. When null default analyzer is used

Return Value

Type: ISearchField
Newly added or existing field

Implements

ISearchFields.Add(String, Boolean, Boolean, Func<Object>, Boolean, Nullable<SearchAnalyzerTypeEnum>)

Exceptions

Exception	Condition
InvalidOperationException	When StoreValues is true and we try to add already existing field but with different value.