FormSubmit Class

Form submit field.

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: 11.0.0

Syntax

public class FormSubmit : FormField

The FormSubmit type exposes the following members.

Constructors

	Name	Description
Public method	FormSubmit

Properties

	Name	Description
Public property	AutomaticValue	Automatic value when the form control is missing (resolves macros in the given string). (Inherited from FormField.)
Public property	CheckUnique	If true, the field is checked for uniqueness. This property is only supported in UIForm. (Inherited from FormField.)
Public property	CssClass	Field's CSS Class. (Inherited from FormField.)
Public property	DevelopmentModeOnly	If true, the field is visible only in development mode (Inherited from FormField.)
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. (Inherited from FormField.)
Public property	DisplayLabel	Indicates if label should be displayed in inline layout. Default value is True. (Inherited from FormField.)
Public property	EditingControl	Editing control. (Inherited from FormField.)
Public property	ErrorLabel	Error label. (Inherited from FormField.)
Public property	Field	Field name for the inner controls. This property is only supported in templated form. (Inherited from FormField.)
Public property	Form	Form where the control is used. (Inherited from FormField.)
Public property	FormControl	Form control. (Inherited from FormField.)
Public property	FormFieldInfo	FormFieldInfo for current control. (Inherited from FormField.)
Public property	HideOnLiveSite	If true, the field is hidden on the live site. (Inherited from FormField.)
Public property	Label	Field label. (Inherited from FormField.)
Public property	Layout	Layout of the field. (Inherited from FormField.)
Public property	ResourceString	Resource string for the label. (Inherited from FormField.)
Public property	ShowRequiredMark	Indicates if required mark (*) should be displayed behind the field label. False by default. (Inherited from FormField.)
Public property	SubmitButton	Submit button.
Public property	Text	Text for the label, has higher priority. (Inherited from FormField.)
Public property	ToolTipResourceString	Name of a resource string used for tooltip. (Inherited from FormField.)
Public property	Trim	If true, the value is trimmed. This property is only supported if used inside the form control. (Inherited from FormField.)
Public property	UseFFI	Indicates if control should load properties from FormFieldInfo. Default TRUE. (Inherited from FormField.)
Public property	Value	Value used for initialization as default value. (Inherited from FormField.)

Methods

	Name	Description
Protected method	CreateChildControls	Creates the child controls. (Inherited from FormField.)
Public method	EnsureControls	Ensures the child controls of the control. (Inherited from FormField.)
Protected method	EnsureInnerControls	Ensures the additional inner controls. (Inherited from FormField.)
Protected method	LoadErrorLabel	Loads the field error label. (Inherited from FormField.)
Protected method	LoadFormControl	Creates submit button in place of form control. (Overrides FormField.LoadFormControl(Control).)
Protected method	LoadLabel	Loads the field label. (Inherited from FormField.)
Protected method	OnInit	Init event handler. (Inherited from FormField.)

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