SearchSettings Class

SearchSettings class provides methods for manipulation with SearchSettingsInfo objects.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.SearchSettings

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

Syntax

[SerializableAttribute]
public class SearchSettings : IEnumerable<SearchSettingsInfo>, 
	IEnumerable

The SearchSettings type exposes the following members.

Constructors

	Name	Description
Public method	SearchSettings

Methods

	Name	Description
Public method	CopyTo	Copies selected fields to another search settings object
Public method	DeleteSearchSettingsInfo(Guid)	Deletes search setting item.
Public method	DeleteSearchSettingsInfo(SearchSettingsInfo)	Deletes search index setting item.
Public method	GetAllSettingsInfos	Returns all search settings as DataSet.
Public method	GetData	Returns xml code of search index settings.
Public method	GetEnumerator	Returns the enumerator
Public method	GetSettingsInfo(Guid)	Returns search setting item by specified II (GUID).
Public method	GetSettingsInfo(String)	Returns search setting item by specified II (GUID).
Public method	LoadData	Loads settings from xml data.
Public method	SearchesAnyOf	Returns true if the search settings indexes any of the given columns
Public method	SetSettingsInfo	Adds or overwrites search setting item in hashtable.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	Batch<SearchSettingsInfo>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToHashSet<SearchSettingsInfo>	Converts the list of objects to a hash set of distinct values (Defined by DataExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToList<SearchSettingsInfo, TTo>	Converts the given collection to a list of values (Defined by BaseExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)

Fields

	Name	Description
Public field Static member	CONTENT	Content field.
Public field Static member	IFIELDNAME	Field field.
Public field Static member	SEARCHABLE	Searchable field.
Public field Static member	TOKENIZED	Tokenized field.

Properties

	Name	Description
Public property	Items	Gets list of all settings items indexed by GUID.
Protected property	ItemsByName	Gets list of all settings items indexed by name.