Click or drag to resize
FormEngineWebControl Class
Form engine web control.
Inheritance Hierarchy

Namespace: CMS.FormControls
Assembly: CMS.FormControls (in CMS.FormControls.dll) Version: 8.2.23
Syntax
C#
public abstract class FormEngineWebControl : WebControl, 
	IFormControl

The FormEngineWebControl type exposes the following members.

Constructors
  NameDescription
Protected methodFormEngineWebControl
Top
Methods
  NameDescription
Public methodGetOtherValues
Returns an array of values of any other fields returned by the control.
Public methodGetSpellCheckFields
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public methodIsValid
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
Public methodLoadControlValue
Loads control value
Public methodLoadOtherValues
Loads the other fields values to the state of the form control
Protected methodRender
Renders user control.
(Overrides WebControlRender(HtmlTextWriter).)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodCallHandled
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Public propertyControlStyle
CSS style of the control.
Public propertyCssClass
CSS class of the control.
(Overrides WebControlCssClass.)
Public propertyDataDR
Node data. This property is used only for passing values to the control.
Public propertyFieldInfo
Field info object.
Public propertyForm
Parent form.
Public propertyFormControlParameter
Helper property to use custom parameter in form control.
Public propertyHasValue
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 propertyStopProcessing
If true, control does not process the data.
Public propertyValidationError
Validation error string shown when the control is not valid.
Public propertyValue
Gets or sets field value. You need to override this method to make the control work properly with the form.
Public propertyValueDisplayName
Gets the display name of the value item. Returns null if display name is not available.
Public propertyValueElementID
Gets ClientID of the control from which the Value is retrieved or null if such a control can't be specified.
Public propertyValueForValidation
Returns value prepared for validation.
Top
See Also