FormControl Class

Form control for the forms.

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.FormControl
            More...

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

Syntax

public class FormControl : CMSDynamicWebControl, 
	INamingContainer

The FormControl type exposes the following members.

Constructors

	Name	Description
Public method	FormControl

Properties

	Name	Description
Public property	AutoPostBack	Gets or sets whether a postback automatically occurs.
Public property	CheckUnique	If true, the field is checked for uniqueness. This property is only supported in UIForm.
Public property	CssClass	Control CSS class.
Public property	EditingControl	Editing control.
Public property	Enabled	Gets or sets state enable. (Overrides WebControl.Enabled.)
Public property	Field	Field name for the inner controls. This property is only supported in templated form.
Public property	Form	Form where the control is used.
Public property	FormControlName	Form control name.
Public property	FormFieldInfo	FormFieldInfo for current control.
Public property	InitCompleted	If true, the initialization of the control has already completed and won't repeat. Set to true in your initialization code. (Inherited from CMSDynamicWebControl.)
Protected property	InitEarly	If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event. (Inherited from CMSDynamicWebControl.)
Public property	IsLiveSite	Indicates if control is used on live site.
Public property	Properties	Properties definition.
Public property	ShortID	Short ID of the control.
Public property	StopProcessing	Indicates if processing of the code of this control should continue. It can be used after raising an event. (Inherited from CMSDynamicWebControl.)
Public property	SupportsDisabledAttribute	Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Overrides WebControl.SupportsDisabledAttribute.)
Protected property	TagKey	TagKey used to render (Div). (Overrides WebControl.TagKey.)
Public property	Text	Gets or sets value converted to string
Public property	Trim	If true, the value is trimmed. This property is only supported if used inside the form control.
Public property	UseFFI	Indicates if control should load properties from FormFieldInfo. Default TRUE.
Public property	Value	Value used for initialization as default value.

Methods

	Name	Description
Protected method	CreateChildControls	Renders the control at run-time. (Inherited from CMSDynamicWebControl.)
Protected method	EnsureChildControl<ControlType>	Ensures the first found child control of the given type in the given variable
Protected method	EnsureInitialization	Initializes the control. Is called within InitComplete or (Inherited from CMSDynamicWebControl.)
Public method	GetValue(String)	Returns the value of the given web part property property.
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given web part property property.
Protected method	InitializeControl	Loads the form control (Overrides CMSDynamicWebControl.InitializeControl().)
Protected method	LoadViewState	Customized LoadViewState. (Inherited from CMSDynamicWebControl.)
Protected method	OnInit	Init event handler. (Inherited from CMSDynamicWebControl.)
Protected method	OnLoad	Load event handler. (Inherited from CMSDynamicWebControl.)
Protected method	OnPreRender	OnPreRender override. (Overrides Control.OnPreRender(EventArgs).)
Protected method	Page_InitComplete	Event handler of page's init complete. (Inherited from CMSDynamicWebControl.)
Public method	Reload	Reloads inner controls. Can be used after additional initialization.
Protected method	SaveViewState	Customized SaveViewState. (Inherited from CMSDynamicWebControl.)
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value.

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