FormField Class

Form field control for the forms.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.PlaceHolder
      CMS.FormEngine.Web.UI.FormField
        CMS.FormEngine.Web.UI.FormSubmit

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

Syntax

public class FormField : PlaceHolder

The FormField type exposes the following members.

Constructors

	Name	Description
Public method	FormField

Properties

	Name	Description
Public property	CheckUnique	If true, the field is checked for uniqueness. This property is only supported in UIForm.
Public property	CssClass	Field's CSS Class.
Public property	DisplayColon	Indicates if colon (:) should be displayed behind the field label. If Form is set then Form.UseColonBehindLabel is used as default value, otherwise false.
Public property	DisplayLabel	Indicates if label should be displayed in inline layout. Default value is True.
Public property	EditingControl	Editing control.
Public property	ErrorLabel	Error label.
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	FormControl	Form control.
Public property	FormFieldInfo	FormFieldInfo for current control.
Public property	Label	Field label.
Public property	Layout	Layout of the field.
Public property	ResourceString	Resource string for the label.
Public property	ShowRequiredMark	Indicates if required mark (*) should be displayed behind the field label. False by default.
Public property	Text	Text for the label, has higher priority.
Public property	ToolTipResourceString	Name of a resource string used for tooltip.
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	Creates the child controls. (Overrides Control.CreateChildControls().)
Public method	EnsureControls	Ensures the child controls of the control.
Protected method	EnsureInnerControls	Ensures the additional inner controls.
Protected method	LoadErrorLabel	Loads the field error label.
Protected method	LoadFormControl	Loads the form control.
Protected method	LoadLabel	Loads the field label.

Extension Methods

	Name	Description
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	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)