CMSDynamicWebControl Class

Base class for dynamic Web controls

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.Base.Web.UI.CMSDynamicWebControl
          CMS.FormEngine.Web.UI.AbstractBasicForm
          CMS.FormEngine.Web.UI.FormControl

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

Syntax

public abstract class CMSDynamicWebControl : CMSWebControl

The CMSDynamicWebControl type exposes the following members.

Constructors

	Name	Description
Protected method	CMSDynamicWebControl

Properties

	Name	Description
Public property	InitCompleted	If true, the initialization of the control has already completed and won't repeat. Set to true in your initialization code.
Protected property	InitEarly	If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	StopProcessing	Indicates if processing of the code of this control should continue. It can be used after raising an event.

Methods

	Name	Description
Protected method	CreateChildControls	Renders the control at run-time. (Overrides Control.CreateChildControls().)
Protected method	EnsureInitialization	Initializes the control. Is called within InitComplete or
Protected method	InitializeControl	Initializes the control. Is called within InitComplete or BeforeInitComplete (based on property InitEarly), or LoadViewState. You need to make sure to set the InitCompleted property once your control is properly initialized to avoid multiple initializations.
Protected method	LoadViewState	Customized LoadViewState. (Overrides WebControl.LoadViewState(Object).)
Protected method	OnInit	Init event handler. (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Overrides Control.OnLoad(EventArgs).)
Protected method	Page_InitComplete	Event handler of page's init complete.
Protected method	SaveViewState	Customized SaveViewState. (Overrides WebControl.SaveViewState().)

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