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: 11.0.0

Syntax

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

The SearchSettings type exposes the following members.

Constructors

	Name	Description
Public method	SearchSettings

Fields

	Name	Description
Public field Static member	CONTENT	Name of flag indicating whether field is considered a content field in context of local indexes.
Public field Static member	IFIELDNAME	Field field.
Public field Static member	SEARCHABLE	Name of flag indicating whether field is searchable in context of local indexes.
Public field Static member	TOKENIZED	Name of flag indicating whether field is tokenized in context of local indexes.

Properties

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

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	GetXmlElement	Gets the XML element for the data
Public method	LoadData	Loads settings from xml data.
Public method	LoadFromXmlElement	Loads the data from the given XML element
Public method	RenameColumn	Renames existing column in settings to the new name
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	Batch<SearchSettingsInfo>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
Public Extension Method	ToHashSet<SearchSettingsInfo>	Converts the list of objects to a hash set of distinct values (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)