IFormControl Interface

Form control interface.

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

Syntax

public interface IFormControl

The IFormControl type exposes the following members.

Properties

	Name	Description
Public property	Enabled	Gets or sets a value indicating whether the control can respond to user interaction.
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	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.
Public property	Visible	Gets or sets a value indicating whether the control and all its child controls are displayed.

Methods

	Name	Description
Public method	GetOtherValues	Returns an array of values of any other fields returned by the control.
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