Click or drag to resize
FormEngineUserControl Class
Common interface for custom user controls used in forms.
Inheritance Hierarchy

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 12.0.0
Syntax
C#
public abstract class FormEngineUserControl : InlineUserControl, 
	IFormControl

The FormEngineUserControl type exposes the following members.

Constructors
  NameDescription
Protected methodFormEngineUserControl
Top
Properties
  NameDescription
Public propertyCheckFieldEmptiness
Indicates that field should be checked on emptiness in validation step by BasicForm. Default TRUE. It is preferable to set to FALSE for controls with complex input such as file uploaders. Field emptiness validation then must be placed in custom form control in IsValid() method.
Public propertyCheckMinMaxLength
Indicates that field should be checked on min/max input length in validation step by BasicForm. Default FALSE. It is preferable to set to TRUE for simple text input controls such as TextBox.
Public propertyCheckRegularExpression
Indicates that field should be checked on regular expressions in validation step by BasicForm. Default FALSE. It is preferable to set to TRUE for controls where user should be able to enter text such as TextBox.
Public propertyCheckUnique
If true, the field is checked for uniqueness. This property is only supported in templated form.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyContextResolver
Gets or sets macro resolver for given control.
Public propertyControlStyle
CSS style of the control.
Public propertyCssClass
CSS class of the control.
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyData
Node data. This property is used only for passing values to the control.
Public propertyDefaultProperties
Control properties
Public propertyDependsOnAnotherField
Indicates if field depends on another field.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
Public propertyEnabled
Gets or sets state enable.
Public propertyErrorMessage
Control custom error message.
Public propertyField
Field name to which the field belongs.
Public propertyFieldInfo
Field info object.
Public propertyForm
Parent form.
Public propertyFormControlParameter
Helper property to use custom parameter in form control.
Public propertyHasDependingFields
Indicates if another fields depend on this field.
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 propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyInputClientID
Client ID of primary input control. If not explicitly set, first client ID of inner control of the form control is returned.
Public propertyInputControlID
Control ID of primary input control. If not explicitly set, first control ID of inner control of the form control is returned.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyRememberOriginalValue
If true, the control remembers the original value for evaluation
Public propertyResolverName
Gets or sets macro resolver name.
Public propertyResourcePrefix
Gets or sets resource prefix for custom texts.
(Overrides AbstractUserControlResourcePrefix.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyStopProcessing
If true, control does not process the data.
(Overrides AbstractUserControlStopProcessing.)
Public propertyText
Gets or sets Value converted to string.
Public propertyTrim
If true, the returned value is trimmed. This property is only supported if used inside the form control. Default false.
Protected propertyUIContext
Control's UI Context
Protected propertyUnderlyingFormControl
Underlying form control, if provided, the form control automatically redirects all properties to that control
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
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.
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyWhereConditionFormat
Format of where condition.
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodStatic memberCheckLength
Checks if field value's length is not shorter or longer than specified borders.
Protected methodConnectToForm
Connects the given form control to a form if necessary
Protected methodContainsColumn
Indicates if form control's DataRow contains requested column.
Protected methodConvertInputValue
Ensures that the given value is represented as null is empty, or converted to proper type.
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodForm_ControlWithDependenciesChanged
Another form control, which has some dependencies, has changed.
Protected methodGetColumnValue
Gets the given column value from the form data
Public methodGetControlInfoMarker
Gets the control info marker code
Protected methodGetDialogConfiguration
Returns dialog configuration from the specified form control settings.
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetOtherValue
Returns a value of other field with specified returned by the control.
Public methodGetOtherValues
Returns an array of values of any other fields returned by the control.
Public methodGetResolvedValueReturnType
Gets resolved property value
Public methodGetSpellCheckFields
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Protected methodGetStringValue
Gets the string value from the given value
Public methodGetValue(String)
Returns the value of the given property.
(Overrides InlineUserControlGetValue(String).)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetWhereCondition
Gets a where condition. Returns where condition formatted by WhereConditionFormat from IFilterFormControl interface if form control implements it. Otherwise returns where condition in [FieldName] = 'Value' format.
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Public methodIsValid
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
Public methodLoadControlFromFFI
Loads control with values in FormFieldInfo.
Public methodLoadControlValue
Loads control value.
Public methodLoadDefaultProperties
Loads the default properties from the given form definition
Public methodLoadOtherValues
Loads the other fields values to the state of the form control
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
OnInit event.
(Overrides AbstractUserControlOnInit(EventArgs).)
Protected methodOnLoad
Load event handler.
(Inherited from AbstractUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Protected methodRaiseOnChanged
Raises the Changed event.
Public methodReloadControl
Reloads form control content.
Protected methodReloadControlInternal
Virtual method that can be used in specific form control to reload its content. It is called after the change of another form control which has some dependencies.
Protected methodRender
Renders user control.
(Overrides AbstractUserControlRender(HtmlTextWriter).)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetValue(String, Object)
Sets the property value of the control, setting the value affects only local property value.
(Overrides InlineUserControlSetValue(String, Object).)
Public methodSetValue(String, Object, Boolean)
Sets the property value of the control, setting the value affects only local property value.
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Protected methodTrimDecimalValue
Trims trailing zero values on decimal value.
Protected methodUnderlyingFormControl_Changed
Changed handler.
Public methodValidateMacroValue
Returns true if the given macro value is valid value for this control
Top
Extension Methods
  NameDescription
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventChanged
Fired on the change to the form control.
Top
See Also
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        CMS.Base.Web.UIAbstractUserControl
          CMS.Base.Web.UIInlineUserControl
            CMS.FormEngine.Web.UIFormEngineUserControl
              CMS.Ecommerce.Web.UIBaseObjectSelector
              CMS.FormEngine.Web.UIAttachmentsControl
              CMS.FormEngine.Web.UIFilterFormControlWrapper
              CMS.FormEngine.Web.UIFormControlError
              CMS.FormEngine.Web.UIFormEngineVisibilityControl
              CMS.FormEngine.Web.UIHtml5InputFormControl
              CMS.FormEngine.Web.UIListFormControl
              CMS.FormEngine.Web.UILocalizableFormEngineUserControl
              CMS.FormEngine.Web.UIReadOnlyFormEngineUserControl
              CMS.FormEngine.Web.UIRecaptchaControl
              CMS.FormEngine.Web.UISecurityCode
              CMS.FormEngine.Web.UISqlFormControl
              CMS.FormEngine.Web.UITextBoxControl
              CMS.FormEngine.Web.UITextBoxWithPlaceholder
              CMS.FormEngine.Web.UITextFilterControl
              CMS.OnlineMarketing.Web.UIConversionDesigner
              CMS.OnlineMarketing.Web.UI.InternalABTestingUrlInput
              CMS.SocialMarketing.Web.UISocialMarketingAutoPostControl
              CMS.UIControlsMacroDesignerGroup
              CMS.UIControlsUniFlatSelector
              CMS.UIControlsUniSelector