CMSSearchDialog Class

CMSSearchDialog class.

Inheritance Hierarchy

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

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

Syntax

[SerializableAttribute]
public class CMSSearchDialog : WebControl, 
	INamingContainer

The CMSSearchDialog type exposes the following members.

Constructors

	Name	Description
Public method	CMSSearchDialog	Constructor.

Fields

	Name	Description
Protected field	mBtnSearch	Search button.
Protected field	mDrpSearchMode	Search mode dropdown list.
Protected field	mDrpSearchScope	Search scope dropdown list.
Protected field	mLblSearchFor	Search for label.
Protected field	mLblSearchMode	Search mode label.
Protected field	mLblSearchScope	Search scope label.
Protected field	mSearchPanel	Outer panel.
Protected field	mStopProcesing	Stop processing.
Protected field	mTxtSearchFor	Search for textbox.

Properties

	Name	Description
Public property	CustomQueryStringData	Gets or sets the custom query string which is placed after search querystring data, do not use & or ? on start of the custom query string.
Public property	SearchButton	Search button.
Public property	SearchExpression	Word(s) to be searched for.
Public property	SearchForLabel	SearchFor label control.
Public property	SearchForTextBox	SearchFor textbox.
Public property	SearchMode	Search mode - any word, all words, exact phrase, etc.
Public property	SearchModeLabel	SearchMode label.
Public property	SearchModeList	SearchMode drop-down list.
Public property	SearchScope	Indicates if all content or only the current section should be searched.
Public property	SearchScopeLabel	SearchScope label.
Public property	SearchScopeList	SearchScope drop-down list.
Public property	ShowSearchMode	Indicates if search mode settings should be displayed.
Public property	ShowSearchScope	Indicates if search scope settings should be displayed.
Public property	StopProcessing	Stop processing
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)

Methods

	Name	Description
Protected method	CreateChildControls	Create child controls (Overrides Control.CreateChildControls().)
Public method Static member	GetSearchMode	Returns the search mode based on the given string.
Public method Static member	GetSearchScope	Returns the search scope based on the given string.
Protected method	OnInit	Renders the control at run-time. (Overrides Control.OnInit(EventArgs).)
Protected method	OnLoad	OnLoad override. (Overrides Control.OnLoad(EventArgs).)
Protected method	Render	Renders the control at design-time. (Overrides WebControl.Render(HtmlTextWriter).)
Protected method	StartSearch	Raises the DoSearch event in case the text is entered.

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	DoSearch	Do search.