Click or drag to resize
CMSSearchResults Class
CMSSearchResults class.
Inheritance Hierarchy

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 9.0.0
Syntax
C#
public class CMSSearchResults : WebControl

The CMSSearchResults type exposes the following members.

Constructors
  NameDescription
Public methodCMSSearchResults
Constructor.
Top
Fields
  NameDescription
Protected fieldmDataPager
DataPager variable.
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmNoResultsLabel
No result label.
Protected fieldmProperties
Control properties variable.
Protected fieldmQueryStringKey
Query string key for setup data pager query string key.
Protected fieldmRepeater
Basic repeater variable.
Protected fieldmSearchDialog
Search dialog.
Top
Properties
  NameDescription
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
Public propertyCacheItemName
Name of the cache item the control will use.
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public propertyClassNames
Property to set and get the ClassNames list (separated by the semicolon).
Public propertyCMSSearchDialogID
Optionally, you can use this property to specify the ID of the source CMSSearchDialog control that provides search parameters.
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
Public propertyCultureCode
Property to set and get the CultureCode.
Public propertyDataSource
Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
Public propertyEnablePaging
Enables paging on Data control.
Public propertyFilterControl
Filter control.
Public propertyFilterName
Gets or Set filter name.
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
Public propertyFooterTemplate
Footer template for direct access.
Public propertyHeaderTemplate
Header template for direct access.
Public propertyCheckPermissions
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 propertyIgnoreTransformations
Indicates if transformations should be ignored and templates for direct access should be used.
Public propertyItemTemplate
Item template for direct access.
Public propertyNoResultsLabel
Label with 'no results' text.
Public propertyOrderBy
Property to set and get the Order by.
Public propertyPagerControl
Data pager control.
Public propertyPath
Property to set and get the Path.
Public propertyQueryStringKey
Query string key used for data pager URL parameter.
Public propertySearchExpression
Word(s) to be searched for.
Public propertySearchMode
Indicates if all content or only the current section should be searched.
Public propertySearchScope
Search mode - any word, all words or exact phrase.
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
Public propertySiteName
Property to set and get the SiteName.
Public propertyStopProcessing
Stop processing
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControlTagKey.)
Public propertyTransformationName
Transformation name in format application.class.transformation.
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyWhereCondition
Property to set and get the Where condition.
Top
Methods
  NameDescription
Public methodStatic memberFindSearchDialog(Control, String)
Finds the search dialog for the given control.
Public methodStatic memberFindSearchDialog(Control, String, Boolean)
Finds the search dialog within the controls structure.
Public methodGetSearchMode
Returns the search mode based on the given string.
Protected methodOnInit
Init event handler.
(Overrides ControlOnInit(EventArgs).)
Protected methodOnLoad
Init event handler.
(Overrides ControlOnLoad(EventArgs).)
Public methodReloadData
Reload data.
Protected methodRender
Renders the results.
(Overrides WebControlRender(HtmlTextWriter).)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnSearchCompleted
Raises when search is completed.
Top
See Also