CMSSearchResults Class

CMSSearchResults class.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.DocumentEngine.Web.UI.CMSSearchResults

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

public class CMSSearchResults : WebControl

The CMSSearchResults type exposes the following members.

Constructors

	Name	Description
Public method	CMSSearchResults	Constructor.

Fields

	Name	Description
Protected field	mDataPager	DataPager variable.
Protected field	mFilterControl	Filter control.
Protected field	mFilterName	Filter name.
Protected field	mNoResultsLabel	No result label.
Protected field	mProperties	Control properties variable.
Protected field	mQueryStringKey	Query string key for setup data pager query string key.
Protected field	mRepeater	Basic repeater variable.
Protected field	mSearchDialog	Search dialog.

Properties

	Name	Description
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line.
Public property	CacheItemName	Name of the cache item the control will use.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	CheckPermissions	Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.
Public property	ClassNames	Property to set and get the ClassNames list (separated by the semicolon).
Public property	CMSSearchDialogID	Optionally, you can use this property to specify the ID of the source CMSSearchDialog control that provides search parameters.
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag.
Public property	CultureCode	Property to set and get the CultureCode.
Public property	DataSource	Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
Public property	EnablePaging	Enables paging on Data control.
Public property	FilterControl	Filter control.
Public property	FilterName	Gets or Set filter name.
Public property	FilterOutDuplicates	Indicates if the duplicated (linked) items should be filtered out from the data.
Public property	FooterTemplate	Footer template for direct access.
Public property	HeaderTemplate	Header template for direct access.
Public property	IgnoreTransformations	Indicates if transformations should be ignored and templates for direct access should be used.
Public property	ItemTemplate	Item template for direct access.
Public property	NoResultsLabel	Label with 'no results' text.
Public property	OrderBy	Property to set and get the Order by.
Public property	PagerControl	Data pager control.
Public property	Path	Property to set and get the Path.
Public property	QueryStringKey	Query string key used for data pager URL parameter.
Public property	SearchExpression	Word(s) to be searched for.
Public property	SearchMode	Indicates if all content or only the current section should be searched.
Public property	SearchScope	Search mode - any word, all words or exact phrase.
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag.
Public property	SiteName	Property to set and get the SiteName.
Public property	StopProcessing	Stop processing
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	TransformationName	Transformation name in format application.class.transformation.
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	WhereCondition	Property to set and get the Where condition.

Methods

	Name	Description
Public method Static member	FindSearchDialog(Control, String)	Finds the search dialog for the given control.
Public method Static member	FindSearchDialog(Control, String, Boolean)	Finds the search dialog within the controls structure.
Public method	GetSearchMode	Returns the search mode based on the given string.
Protected method	OnInit	Init event handler. (Overrides Control.OnInit(EventArgs).)
Protected method	OnLoad	Init event handler. (Overrides Control.OnLoad(EventArgs).)
Public method	ReloadData	Reload data.
Protected method	Render	Renders the results. (Overrides WebControl.Render(HtmlTextWriter).)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnSearchCompleted	Raises when search is completed.