TextBoxControl Class |
Namespace: CMS.FormEngine.Web.UI
public abstract class TextBoxControl : FormEngineUserControl
The TextBoxControl type exposes the following members.
Name | Description | |
---|---|---|
TextBoxControl |
Name | Description | |
---|---|---|
AutoCompleteCompletionInterval |
Time in milliseconds when the timer will kick in to get suggestions using the web service.
| |
AutoCompleteCompletionListCssClass |
CSS class that will be used to style the completion list flyout.
| |
AutoCompleteCompletionListHighlightedItemCssClass |
CSS class that will be used to style a highlighted item in the AutoComplete list flyout.
| |
AutoCompleteCompletionListItemCssClass |
CSS class that will be used to style an item in the AutoComplete list flyout.
| |
AutoCompleteCompletionSetCount |
Number of suggestions to be retrieved from the web service.
| |
AutoCompleteContextKey |
User/page specific context provided to an optional overload of the web method described by ServiceMethod/ServicePath. If the context key is used, it should have the same signature with an additional parameter named contextKey of type string:
[System.Web.Services.WebMethod]
[System.Web.Script.Services.ScriptMethod]
public string[] GetCompletionList(
string prefixText, int count, string contextKey) { ... }
Note that you can replace "GetCompletionList" with a name of your choice, but the return type and parameter name and type must exactly match, including case.
| |
AutoCompleteDelimiterCharacters |
Specifies one or more character(s) used to separate words. The text in the AutoComplete textbox is tokenized using these characters and the webservice completes the last token.
| |
AutoCompleteEnableCaching |
Whether client side caching is enabled.
| |
AutoCompleteFirstRowSelected |
Determines if the first option in the AutoComplete list will be selected by default.
| |
AutoCompleteMinimumPrefixLength |
Minimum number of characters that must be entered before getting suggestions from the web service.
| |
AutoCompleteServiceMethod |
The web service method to be called. The signature of this method must match the following:
[System.Web.Services.WebMethod]
[System.Web.Script.Services.ScriptMethod]
public string[] GetCompletionList(string prefixText, int count) { ... }
Note that you can replace "GetCompletionList" with a name of your choice, but the return type and parameter name and type must exactly match, including case.
| |
AutoCompleteServicePath |
The path to the web service that the extender will pull the word\sentence completions from. If this is not provided, the service method should be a page method.
| |
AutoCompleteShowOnlyCurrentWordInCompletionListItem |
If true and DelimiterCharacters are specified, then the AutoComplete list items display suggestions for the current word to be completed and do not display the rest of the tokens.
| |
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.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
CheckUnique |
If true, the field is checked for uniqueness. This property is only supported in templated form.
(Inherited from FormEngineUserControl.) | |
ComponentName |
Component name
(Inherited from AbstractUserControl.) | |
ContextResolver |
Gets or sets macro resolver for given control.
(Inherited from FormEngineUserControl.) | |
ControlStyle |
CSS style of the control.
(Inherited from FormEngineUserControl.) | |
CssClass |
CSS class of the control.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
DefaultProperties |
Control properties
(Inherited from FormEngineUserControl.) | |
DependsOnAnotherField |
Indicates if field depends on another field.
(Inherited from FormEngineUserControl.) | |
DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) | |
EditedObject |
Control's edited object
(Inherited from FormEngineUserControl.) | |
Enabled |
Gets or sets the enabled state of the control.
(Overrides FormEngineUserControlEnabled.) | |
ErrorMessage |
Control custom error message.
(Inherited from FormEngineUserControl.) | |
Field |
Field name to which the field belongs.
(Inherited from FormEngineUserControl.) | |
FieldInfo |
Field info object.
(Inherited from FormEngineUserControl.) | |
FilterEnabled |
Indicates if filter is enabled.
| |
FilterInterval |
An integer containing the interval (in milliseconds) in which the field's contents are filtered, defaults to 250.
| |
FilterMode |
The filter mode to apply, either ValidChars (default) or InvalidChars. If set to InvalidChars, FilterType must be set to Custom; if set to ValidChars, FilterType must contain Custom.
| |
FilterType |
The type of filter to apply, as a comma-separated combination of Numbers, LowercaseLetters, UppercaseLetters, and Custom. If Custom is specified, the ValidChars field will be used in addition to other settings such as Numbers.
| |
FilterTypeValue |
This property gets the form control settings of the FilterType.
| |
Form |
Parent form.
(Inherited from FormEngineUserControl.) | |
FormControlParameter |
Helper property to use custom parameter in form control.
(Inherited from FormEngineUserControl.) | |
HasDependingFields |
Indicates if another fields depend on this field.
(Inherited from FormEngineUserControl.) | |
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
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
InputControlID |
Control ID of primary input control. If not explicitly set, first control ID of inner control of the form control is returned.
(Inherited from FormEngineUserControl.) | |
InvalidChars |
A string consisting of all characters considered invalid for the text field, if "Custom" is specified as the filter type and "InvalidChars" as the filter mode. Otherwise this parameter is ignored.
| |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) | |
IsTextArea |
Gets (or sets) the value indicating if form control is displayed as TextArea control.
If FALSE then form control is displayed as TextBox control. Setting this value
is performed only if FieldInfo is null.
| |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
MaxLength |
Maximum text length
| |
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
(Inherited from FormEngineUserControl.) | |
ResolverName |
Gets or sets macro resolver name.
(Inherited from FormEngineUserControl.) | |
ResourcePrefix |
Gets or sets resource prefix for custom texts.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
Text |
Gets or sets Value converted to string.
(Inherited from FormEngineUserControl.) | |
TextBox |
Textbox control
| |
Trim |
If true, the returned value is trimmed. This property is only supported if used inside the form control. Default false.
(Inherited from FormEngineUserControl.) | |
UIContext |
Control's UI Context
(Inherited from FormEngineUserControl.) | |
UnderlyingFormControl |
Underlying form control, if provided, the form control automatically redirects all properties to that control
(Inherited from FormEngineUserControl.) | |
UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) | |
ValidationError |
Validation error string shown when the control is not valid.
(Inherited from FormEngineUserControl.) | |
ValidChars |
A string consisting of all characters considered valid for the text field, if "Custom" is specified as the filter type. Otherwise this parameter is ignored.
| |
Value |
Gets or sets form control value.
(Overrides FormEngineUserControlValue.) | |
ValueAccessFunctionName |
Gets or sets the unique name of the client function to be rendered, which can be used to get the value of the text box.
| |
ValueDisplayName |
Gets the display name of the value item. Returns null if display name is not available.
(Inherited from FormEngineUserControl.) | |
ValueElementID |
Gets ClientID of the control from which the Value is retrieved or
null if such a control can't be specified.
(Inherited from FormEngineUserControl.) | |
ValueForValidation |
Returns value prepared for validation.
(Inherited from FormEngineUserControl.) | |
ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) | |
WatermarkCssClass |
The CSS class to apply to the TextBox when it has no value (e.g. the watermark text is shown).
| |
WatermarkText |
The text to show when the control has no value.
| |
WhereConditionFormat |
Format of where condition.
(Inherited from FormEngineUserControl.) | |
Width |
Width of the text box.
|
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.) | |
ConnectToForm |
Connects the given form control to a form if necessary
(Inherited from FormEngineUserControl.) | |
ContainsColumn |
Indicates if form control's DataRow contains requested column.
(Inherited from FormEngineUserControl.) | |
ConvertInputValue |
Ensures that the given value is represented as null is empty, or converted to proper type.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
GetColumnValue |
Gets the given column value from the form data
(Inherited from FormEngineUserControl.) | |
GetControlInfoMarker |
Gets the control info marker code
(Inherited from FormEngineUserControl.) | |
GetDialogConfiguration |
Returns dialog configuration from the specified form control settings.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
GetOtherValues |
Returns an array of values of any other fields returned by the control.
(Inherited from FormEngineUserControl.) | |
GetResolvedValueReturnType |
Gets resolved property value
(Inherited from FormEngineUserControl.) | |
GetSpellCheckFields |
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
(Overrides FormEngineUserControlGetSpellCheckFields.) | |
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
(Inherited from FormEngineUserControl.) | |
GetValue(String) |
Returns the value of the given property.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
IsValid |
Returns true if user control is valid.
(Overrides FormEngineUserControlIsValid.) | |
LoadControlFromFFI |
Loads control with values in FormFieldInfo.
(Inherited from FormEngineUserControl.) | |
LoadControlValue |
Loads control value.
(Inherited from FormEngineUserControl.) | |
LoadDefaultProperties |
Loads the default properties from the given form definition
(Inherited from FormEngineUserControl.) | |
LoadOtherValues |
Loads the other fields values to the state of the form control
(Inherited from FormEngineUserControl.) | |
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 |
Init event handler
(Overrides FormEngineUserControlOnInit(EventArgs).) | |
OnLoad |
Load event handler
(Overrides AbstractUserControlOnLoad(EventArgs).) | |
OnPreRender |
PreRender event handler
(Overrides AbstractUserControlOnPreRender(EventArgs).) | |
RaiseOnChanged |
Raises the Changed event.
(Inherited from FormEngineUserControl.) | |
ReloadControl |
Reloads form control content.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
Render |
Renders user control.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
SetValue(String, Object, Boolean) |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from FormEngineUserControl.) | |
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.
(Inherited from FormEngineUserControl.) | |
UnderlyingFormControl_Changed |
Changed handler.
(Inherited from FormEngineUserControl.) | |
ValidateMacroValue |
Returns true if the given macro value is valid value for this control
(Inherited from FormEngineUserControl.) |
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.) |
Name | Description | |
---|---|---|
Changed |
Fired on the change to the form control.
(Inherited from FormEngineUserControl.) |