CMSQueryProperties Class

Properties container for the Query based controls.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.DocumentEngine.Web.UI.CMSAbstractBaseProperties
          CMS.DocumentEngine.Web.UI.CMSAbstractQueryProperties
            CMS.DocumentEngine.Web.UI.CMSQueryProperties

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

Syntax

public sealed class CMSQueryProperties : CMSAbstractQueryProperties, 
	ICMSQueryProperties, ICMSBaseProperties

The CMSQueryProperties type exposes the following members.

Constructors

	Name	Description
Public method	CMSQueryProperties

Fields

	Name	Description
Protected field	mControlContext	Control context. (Inherited from CMSAbstractBaseProperties.)
Protected field	mParent	Parent control. (Inherited from CMSAbstractBaseProperties.)
Protected field	mStopProcessing	Stop processing this control. (Inherited from CMSAbstractBaseProperties.)

Properties

	Name	Description
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from CMSAbstractBaseProperties.)
Public property	CacheItemName	Name of the cache item the control will use. (Inherited from CMSAbstractBaseProperties.)
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached. (Inherited from CMSAbstractQueryProperties.)
Public property	ControlContext	Control context. (Inherited from CMSAbstractBaseProperties.)
Public property	ControlTagKey	Overrides the generation of the SPAN tag with custom tag. (Inherited from CMSAbstractBaseProperties.)
Public property	ForceCacheMinutes	Gets or sets the value that indicates whether cache minutes must be set manually (Cache minutes value is independent on view mode and cache settings) (Inherited from CMSAbstractQueryProperties.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	IsSelected	Gets or sets the value that indicates whether current datasource contains selected item. (Inherited from CMSAbstractQueryProperties.)
Public property	OrderBy	ORDER BY part of the SQL statement. (Inherited from CMSAbstractBaseProperties.)
Public property	PageSize	Number of items per page. (Inherited from CMSAbstractQueryProperties.)
Public property	ParentControl	Parent control. (Inherited from CMSAbstractBaseProperties.)
Public property	QueryName	Query name in format application.class.query. (Inherited from CMSAbstractQueryProperties.)
Public property	QueryParameters	Query parameters. (Inherited from CMSAbstractQueryProperties.)
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database. (Inherited from CMSAbstractBaseProperties.)
Public property	SelectedDatabaseColumnName	Gets or sets columns name by which the item is selected. (Inherited from CMSAbstractQueryProperties.)
Public property	SelectedQueryStringKeyName	Gets or sets query string key name. Presence of the key in query string indicates, that some item should be selected. The item is determined by query string value. (Inherited from CMSAbstractQueryProperties.)
Public property	SelectedValidationType	Gets or sets validation type for query string value which determines selected item. Options are int, guid and string. (Inherited from CMSAbstractQueryProperties.)
Public property	SelectTopN	Select top N rows. (Inherited from CMSAbstractQueryProperties.)
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	SiteName	Site code name. (Inherited from CMSAbstractBaseProperties.)
Public property	StopProcessing	Indicates if processing of the control should be stopped and the control should not retrieve or display any data. (Inherited from CMSAbstractBaseProperties.)
Public property	TopN	Select top N rows. (Inherited from CMSAbstractBaseProperties.)
Public property	WhereCondition	WHERE part of the SQL statement. (Inherited from CMSAbstractBaseProperties.)

Methods

	Name	Description
Public method	ClearCache	Clears the cached items. (Inherited from CMSAbstractQueryProperties.)
Public method	GetCacheDependency	Gets the cache dependency for the control. (Inherited from CMSAbstractBaseProperties.)
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source. (Inherited from CMSAbstractQueryProperties.)
Public method	LoadData(Boolean)	Loads data from the database according to the current values of properties. (Inherited from CMSAbstractQueryProperties.)
Public method	LoadData(Boolean, Int32, Int32, Int32)	Loads data from the database according to the current values of properties. (Inherited from CMSAbstractQueryProperties.)
Protected method	OnInit	Init event handler. (Inherited from CMSWebControl.)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSAbstractBaseProperties.)
Public method	SetContext	Sets the control context. (Inherited from CMSAbstractBaseProperties.)

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.)