FormEngineWebControl Class

Form engine web control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.FormControls.FormEngineWebControl
        CMS.FormControls.EditingFormControl

Namespace: CMS.FormControls
Assembly: CMS.FormControls (in CMS.FormControls.dll) Version: 9.0.0

Syntax

public abstract class FormEngineWebControl : WebControl, 
	IFormControl

The FormEngineWebControl type exposes the following members.

Constructors

	Name	Description
Protected method	FormEngineWebControl

Properties

	Name	Description
Public property	ControlStyle	CSS style of the control.
Public property	CssClass	CSS class of the control. (Overrides WebControl.CssClass.)
Public property	DataDR	Node data. This property is used only for passing values to the control.
Public property	FieldInfo	Field info object.
Public property	Form	Parent form.
Public property	FormControlParameter	Helper property to use custom parameter in form control.
Public property	HasValue	Returns true if the control has value, if false, the value from the control should not be used within the form to update the data
Public property	StopProcessing	If true, control does not process the data.
Public property	ValidationError	Validation error string shown when the control is not valid.
Public property	Value	Gets or sets field value. You need to override this method to make the control work properly with the form.
Public property	ValueDisplayName	Gets the display name of the value item. Returns null if display name is not available.
Public property	ValueElementID	Gets ClientID of the control from which the Value is retrieved or null if such a control can't be specified.
Public property	ValueForValidation	Returns value prepared for validation.

Methods

	Name	Description
Public method	GetOtherValues	Returns an array of values of any other fields returned by the control.
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public method	IsValid	Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
Public method	LoadControlValue	Loads control value
Public method	LoadOtherValues	Loads the other fields values to the state of the form control
Protected method	Render	Renders user control. (Overrides WebControl.Render(HtmlTextWriter).)

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