FormEngineUserControl Class |
Namespace: CMS.FormEngine.Web.UI
public abstract class FormEngineUserControl : InlineUserControl, IFormControl
The FormEngineUserControl type exposes the following members.
Name | Description | |
---|---|---|
FormEngineUserControl |
Name | Description | |
---|---|---|
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.
| |
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.
| |
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.
| |
CheckUnique |
If true, the field is checked for uniqueness. This property is only supported in templated form.
| |
ComponentName |
Component name
(Inherited from AbstractUserControl.) | |
ContextResolver |
Gets or sets macro resolver for given control.
| |
ControlStyle |
CSS style of the control.
| |
CssClass |
CSS class of the control.
| |
CurrentDocument |
Current document
(Inherited from AbstractUserControl.) | |
CurrentPageInfo |
Current page info
(Inherited from AbstractUserControl.) | |
CurrentSite |
Current site
(Inherited from AbstractUserControl.) | |
CurrentUser |
Current user
(Inherited from AbstractUserControl.) | |
Data |
Node data. This property is used only for passing values to the control.
| |
DefaultProperties |
Control properties
| |
DependsOnAnotherField |
Indicates if field depends on another field.
| |
DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) | |
EditedObject |
Control's edited object
| |
Enabled |
Gets or sets state enable.
| |
ErrorMessage |
Control custom error message.
| |
Field |
Field name to which the field belongs.
| |
FieldInfo |
Field info object.
| |
Form |
Parent form.
| |
FormControlParameter |
Helper property to use custom parameter in form control.
| |
HasDependingFields |
Indicates if another fields depend on this field.
| |
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
| |
HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) | |
InputClientID |
Client ID of primary input control. If not explicitly set, first client ID of inner control of the form control is returned.
| |
InputControlID |
Control ID of primary input control. If not explicitly set, first control ID of inner control of the form control is returned.
| |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) | |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) | |
Parameter |
Control parameter.
(Inherited from InlineUserControl.) | |
Properties |
Control properties.
(Inherited from InlineUserControl.) | |
RememberOriginalValue |
If true, the control remembers the original value for evaluation
| |
ResolverName |
Gets or sets macro resolver name.
| |
ResourcePrefix |
Gets or sets resource prefix for custom texts.
(Overrides AbstractUserControlResourcePrefix.) | |
ResourcePrefixes |
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.) | |
ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) | |
StopProcessing |
If true, control does not process the data.
(Overrides AbstractUserControlStopProcessing.) | |
Text |
Gets or sets Value converted to string.
| |
Trim |
If true, the returned value is trimmed. This property is only supported if used inside the form control. Default false.
| |
UIContext |
Control's UI Context
| |
UnderlyingFormControl |
Underlying form control, if provided, the form control automatically redirects all properties to that control
| |
UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) | |
ValidationError |
Validation error string shown when the control is not valid.
| |
Value |
Gets or sets field value. You need to override this method to make the control work properly with the form.
| |
ValueDisplayName |
Gets the display name of the value item. Returns null if display name is not available.
| |
ValueElementID |
Gets ClientID of the control from which the Value is retrieved or
null if such a control can't be specified.
| |
ValueForValidation |
Returns value prepared for validation.
| |
ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) | |
WhereConditionFormat |
Format of where condition.
|
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) | |
CheckLength |
Checks if field value's length is not shorter or longer than specified borders.
| |
ConnectToForm |
Connects the given form control to a form if necessary
| |
ContainsColumn |
Indicates if form control's DataRow contains requested column.
| |
ConvertInputValue |
Ensures that the given value is represented as null is empty, or converted to proper type.
| |
EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) | |
Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) | |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) | |
EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) | |
EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) | |
EvalDecimal |
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.) | |
EvalDouble |
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.) | |
EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) | |
EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) | |
EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) | |
EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) | |
EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) | |
EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
Form_ControlWithDependenciesChanged |
Another form control, which has some dependencies, has changed.
| |
GetColumnValue |
Gets the given column value from the form data
| |
GetControlInfoMarker |
Gets the control info marker code
| |
GetDialogConfiguration |
Returns dialog configuration from the specified form control settings.
| |
GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) | |
GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetOtherValue |
Returns a value of other field with specified returned by the control.
| |
GetOtherValues |
Returns an array of values of any other fields returned by the control.
| |
GetResolvedValueReturnType |
Gets resolved property value
| |
GetSpellCheckFields |
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
| |
GetString |
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.) | |
GetStringValue |
Gets the string value from the given value
| |
GetValue(String) |
Returns the value of the given property.
(Overrides InlineUserControlGetValue(String).) | |
GetValueReturnType(String, ReturnType) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
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.
| |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
IsValid |
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
| |
LoadControlFromFFI |
Loads control with values in FormFieldInfo.
| |
LoadControlValue |
Loads control value.
| |
LoadDefaultProperties |
Loads the default properties from the given form definition
| |
LoadOtherValues |
Loads the other fields values to the state of the form control
| |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) | |
LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) | |
OnContentLoaded |
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.) | |
OnInit |
OnInit event.
(Overrides AbstractUserControlOnInit(EventArgs).) | |
OnLoad |
Load event handler.
(Inherited from AbstractUserControl.) | |
OnPreRender |
PreRender event handler.
(Inherited from AbstractUserControl.) | |
RaiseOnChanged |
Raises the Changed event.
| |
ReloadControl |
Reloads form control content.
| |
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.
| |
Render |
Renders user control.
(Overrides AbstractUserControlRender(HtmlTextWriter).) | |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) | |
SetValue(String, Object) |
Sets the property value of the control, setting the value affects only local property value.
(Overrides InlineUserControlSetValue(String, Object).) | |
SetValue(String, Object, Boolean) |
Sets the property value of the control, setting the value affects only local property value.
| |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) | |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
TrackViewState |
Tracks the view state.
(Inherited from InlineUserControl.) | |
TrimDecimalValue |
Trims trailing zero values on decimal value.
| |
UnderlyingFormControl_Changed |
Changed handler.
| |
ValidateMacroValue |
Returns true if the given macro value is valid value for this control
|
Name | Description | |
---|---|---|
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.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) |