FormEngineUserControl Class

Common interface for custom user controls used in forms.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.FormEngine.Web.UI.FormEngineUserControl
              More...

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

Syntax

public abstract class FormEngineUserControl : InlineUserControl, 
	IFormControl

The FormEngineUserControl type exposes the following members.

Constructors

	Name	Description
Protected method	FormEngineUserControl

Properties

	Name	Description
Public property	CheckFieldEmptiness	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 property	CheckMinMaxLength	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 property	CheckRegularExpression	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 property	CheckUnique	If true, the field is checked for uniqueness. This property is only supported in templated form.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ContextResolver	Gets or sets macro resolver for given control.
Public property	ControlStyle	CSS style of the control.
Public property	CssClass	CSS class of the control.
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	Data	Node data. This property is used only for passing values to the control.
Public property	DefaultProperties	Control properties
Public property	DependsOnAnotherField	Indicates if field depends on another field.
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object
Public property	Enabled	Gets or sets state enable.
Public property	ErrorMessage	Control custom error message.
Public property	Field	Field name to which the field belongs.
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	HasDependingFields	Indicates if another fields depend on this field.
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	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	InputClientID	Client ID of primary input control. If not explicitly set, first client ID of inner control of the form control is returned.
Public property	InputControlID	Control ID of primary input control. If not explicitly set, first control ID of inner control of the form control is returned.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	RememberOriginalValue	If true, the control remembers the original value for evaluation
Public property	ResolverName	Gets or sets macro resolver name.
Public property	ResourcePrefix	Gets or sets resource prefix for custom texts. (Overrides AbstractUserControl.ResourcePrefix.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	StopProcessing	If true, control does not process the data. (Overrides AbstractUserControl.StopProcessing.)
Public property	Text	Gets or sets Value converted to string.
Public property	Trim	If true, the returned value is trimmed. This property is only supported if used inside the form control. Default false.
Protected property	UIContext	Control's UI Context
Protected property	UnderlyingFormControl	Underlying form control, if provided, the form control automatically redirects all properties to that control
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
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.
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)
Public property	WhereConditionFormat	Format of where condition.

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method Static member	CheckLength	Checks if field value's length is not shorter or longer than specified borders.
Protected method	ConnectToForm	Connects the given form control to a form if necessary
Protected method	ContainsColumn	Indicates if form control's DataRow contains requested column.
Protected method	ConvertInputValue	Ensures that the given value is represented as null is empty, or converted to proper type.
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Protected method	Form_ControlWithDependenciesChanged	Another form control, which has some dependencies, has changed.
Protected method	GetColumnValue	Gets the given column value from the form data
Public method	GetControlInfoMarker	Gets the control info marker code
Protected method	GetDialogConfiguration	Returns dialog configuration from the specified form control settings.
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetOtherValue	Returns a value of other field with specified returned by the control.
Public method	GetOtherValues	Returns an array of values of any other fields returned by the control.
Public method	GetResolvedValue<ReturnType>	Gets resolved property value
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Protected method	GetStringValue	Gets the string value from the given value
Public method	GetValue(String)	Returns the value of the given property. (Overrides InlineUserControl.GetValue(String).)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetWhereCondition	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 method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Public method	IsValid	Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
Public method	LoadControlFromFFI	Loads control with values in FormFieldInfo.
Public method	LoadControlValue	Loads control value.
Public method	LoadDefaultProperties	Loads the default properties from the given form definition
Public method	LoadOtherValues	Loads the other fields values to the state of the form control
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	OnInit event. (Overrides AbstractUserControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Protected method	RaiseOnChanged	Raises the Changed event.
Public method	ReloadControl	Reloads form control content.
Protected method	ReloadControlInternal	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 method	Render	Renders user control. (Overrides AbstractUserControl.Render(HtmlTextWriter).)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SetValue(String, Object)	Sets the property value of the control, setting the value affects only local property value. (Overrides InlineUserControl.SetValue(String, Object).)
Public method	SetValue(String, Object, Boolean)	Sets the property value of the control, setting the value affects only local property value.
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)
Protected method	TrimDecimalValue	Trims trailing zero values on decimal value.
Protected method	UnderlyingFormControl_Changed	Changed handler.
Public method	ValidateMacroValue	Returns true if the given macro value is valid value for this control

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

Events

	Name	Description
Public event	Changed	Fired on the change to the form control.