ISearchProvider.Search Method

Searches content specified by parameters.

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

Syntax

DataSet Search(
	string siteName,
	string searchNodePath,
	string cultureCode,
	string searchExpression,
	SearchModeEnum searchMode,
	bool searchChildNodes,
	string classNames,
	bool filterResultsByReadPermission,
	bool searchOnlyPublished,
	string whereCondition,
	string orderBy,
	bool combineWithDefaultCulture
)

Parameters

siteName

Type: System.String
Site code name

searchNodePath

Type: System.String
Starting alias path without %

cultureCode

Type: System.String
Culture code

searchExpression

Type: System.String
Expression to searched for

searchMode

Type: CMS.Search.SearchModeEnum
Search mode - all words, any word, exact phrase

searchChildNodes

Type: System.Boolean
Search child nodes under the given starting path

classNames

Type: System.String
Class names in format cms.article;cms.news

filterResultsByReadPermission

Type: System.Boolean
Indicates if only documents the current user is allowed to read should be displayed

searchOnlyPublished

Type: System.Boolean
Indicates if only published documents should be searched

whereCondition

Type: System.String
Where condition

orderBy

Type: System.String
Order by clause

combineWithDefaultCulture

Type: System.Boolean
Specifies if return the default culture document when specified culture not found

Return Value

Type: DataSet