SearchIndexSettingsInfo Class

Search Index Settings Info object.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.SearchIndexSettingsInfo

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

Syntax

public class SearchIndexSettingsInfo : IDataContainer, 
	ISimpleDataContainer

The SearchIndexSettingsInfo type exposes the following members.

Constructors

	Name	Description
Public method	SearchIndexSettingsInfo

Fields

	Name	Description
Protected field	mData	Collection of the data contents.
Public field Static member	TYPE_ALLOWED	Public constant for item of type allowed.
Public field Static member	TYPE_EXLUDED	Public constant for item of type excluded.

Properties

	Name	Description
Public property	ClassNames	Gets or sets class names of the custom tables.
Public property	ColumnNames	Column names.
Public property	ForumNames	Gets or sets the forum names.
Public property	ID	Gets or sets item identifier.
Public property	IncludeAttachments	Enables or disables attachment content indexing. If true, all the attachments with supported file type (for which there is an extractor and which is allowed in the Site Manager setting) the text is extracted and included in the search index.
Public property	IncludeBlogs	Enables or disables blogs inclusion.
Public property	IncludeCategories	Enables or disables categories inclusion.
Public property	IncludeForums	Enables or disables forums inclusion.
Public property	IncludeMessageCommunication	Enables or disables message communication inclusion.
Public property	Item	Gets or sets the value of the column.
Public property	Path	Gets or sets path.
Public property	SiteName	Gets or sets the item sitename.
Public property	Type	Gets or sets type.
Public property	WhereCondition	Gets or sets the where condition.

Methods

	Name	Description
Public method	ContainsColumn	Returns true if the object contains specified column.
Public method	GetValue	Returns value of column.
Public method	MatchClassNames	Returns true if there is classname in this item which matches specified parameter.
Public method	MatchPath	Returns true if Path in this item matches specified parameter.
Public method	SetValue	Sets value of column.
Public method	TryGetValue	Returns value of column.

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)