CMSAbstractBaseProperties Class

CMSAbstractBaseProperties class.

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.CMSAbstractControlProperties
          CMS.DocumentEngine.Web.UI.CMSAbstractQueryProperties
          CMS.DocumentEngine.Web.UI.CMSBaseProperties

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

Syntax

public abstract class CMSAbstractBaseProperties : CMSWebControl, 
	ICMSBaseProperties

The CMSAbstractBaseProperties type exposes the following members.

Constructors

	Name	Description
Protected method	CMSAbstractBaseProperties()	BaseProperties constructor.
Protected method	CMSAbstractBaseProperties(HtmlTextWriterTag)	Base properties constructor.

Fields

	Name	Description
Protected field	mControlContext	Control context.
Protected field	mParent	Parent control.
Protected field	mStopProcessing	Stop processing this control.

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	ControlContext	Control context.
Public property	ControlTagKey	Overrides the generation of the SPAN tag with custom tag.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	OrderBy	ORDER BY part of the SQL statement.
Public property	ParentControl	Parent control.
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	SiteName	Site code name.
Public property	StopProcessing	Indicates if processing of the control should be stopped and the control should not retrieve or display any data.
Public property	TopN	Select top N rows.
Public property	WhereCondition	WHERE part of the SQL statement.

Methods

	Name	Description
Public method	GetCacheDependency	Gets the cache dependency for the control.
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source.
Protected method	OnInit	Init event handler. (Inherited from CMSWebControl.)
Public method	ReleaseContext	Releases the control context.
Public method	SetContext	Sets the control context.

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