Click or drag to resize
TextBoxControl Class
Base class for the textbox form control
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 TextBoxControl : FormEngineUserControl

The TextBoxControl type exposes the following members.

Constructors
  NameDescription
Protected methodTextBoxControl
Top
Properties
  NameDescription
Public propertyAutoCompleteCompletionInterval
Time in milliseconds when the timer will kick in to get suggestions using the web service.
Public propertyAutoCompleteCompletionListCssClass
CSS class that will be used to style the completion list flyout.
Public propertyAutoCompleteCompletionListHighlightedItemCssClass
CSS class that will be used to style a highlighted item in the AutoComplete list flyout.
Public propertyAutoCompleteCompletionListItemCssClass
CSS class that will be used to style an item in the AutoComplete list flyout.
Public propertyAutoCompleteCompletionSetCount
Number of suggestions to be retrieved from the web service.
Public propertyAutoCompleteContextKey
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.
Public propertyAutoCompleteDelimiterCharacters
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.
Public propertyAutoCompleteEnableCaching
Whether client side caching is enabled.
Public propertyAutoCompleteFirstRowSelected
Determines if the first option in the AutoComplete list will be selected by default.
Public propertyAutoCompleteMinimumPrefixLength
Minimum number of characters that must be entered before getting suggestions from the web service.
Public propertyAutoCompleteServiceMethod
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.
Public propertyAutoCompleteServicePath
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.
Public propertyAutoCompleteShowOnlyCurrentWordInCompletionListItem
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.
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.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Public propertyCheckUnique
If true, the field is checked for uniqueness. This property is only supported in templated form.
(Inherited from FormEngineUserControl.)
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyContextResolver
Gets or sets macro resolver for given control.
(Inherited from FormEngineUserControl.)
Public propertyControlStyle
CSS style of the control.
(Inherited from FormEngineUserControl.)
Public propertyCssClass
CSS class of the control.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Public propertyDefaultProperties
Control properties
(Inherited from FormEngineUserControl.)
Public propertyDependsOnAnotherField
Indicates if field depends on another field.
(Inherited from FormEngineUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from FormEngineUserControl.)
Public propertyEnabled
Gets or sets the enabled state of the control.
(Overrides FormEngineUserControlEnabled.)
Public propertyErrorMessage
Control custom error message.
(Inherited from FormEngineUserControl.)
Public propertyField
Field name to which the field belongs.
(Inherited from FormEngineUserControl.)
Public propertyFieldInfo
Field info object.
(Inherited from FormEngineUserControl.)
Public propertyFilterEnabled
Indicates if filter is enabled.
Public propertyFilterInterval
An integer containing the interval (in milliseconds) in which the field's contents are filtered, defaults to 250.
Public propertyFilterMode
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.
Public propertyFilterType
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.
Public propertyFilterTypeValue
This property gets the form control settings of the FilterType.
Public propertyForm
Parent form.
(Inherited from FormEngineUserControl.)
Public propertyFormControlParameter
Helper property to use custom parameter in form control.
(Inherited from FormEngineUserControl.)
Public propertyHasDependingFields
Indicates if another fields depend on this field.
(Inherited from FormEngineUserControl.)
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
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Public propertyInputControlID
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.)
Public propertyInvalidChars
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.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyIsTextArea
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.
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyMaxLength
Maximum text length
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
(Inherited from FormEngineUserControl.)
Public propertyResolverName
Gets or sets macro resolver name.
(Inherited from FormEngineUserControl.)
Public propertyResourcePrefix
Gets or sets resource prefix for custom texts.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Public propertyText
Gets or sets Value converted to string.
(Inherited from FormEngineUserControl.)
Protected propertyTextBox
Textbox control
Public propertyTrim
If true, the returned value is trimmed. This property is only supported if used inside the form control. Default false.
(Inherited from FormEngineUserControl.)
Protected propertyUIContext
Control's UI Context
(Inherited from FormEngineUserControl.)
Protected propertyUnderlyingFormControl
Underlying form control, if provided, the form control automatically redirects all properties to that control
(Inherited from FormEngineUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyValidationError
Validation error string shown when the control is not valid.
(Inherited from FormEngineUserControl.)
Public propertyValidChars
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.
Public propertyValue
Gets or sets form control value.
(Overrides FormEngineUserControlValue.)
Public propertyValueAccessFunctionName
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.
Public propertyValueDisplayName
Gets the display name of the value item. Returns null if display name is not available.
(Inherited from FormEngineUserControl.)
Public propertyValueElementID
Gets ClientID of the control from which the Value is retrieved or null if such a control can't be specified.
(Inherited from FormEngineUserControl.)
Public propertyValueForValidation
Returns value prepared for validation.
(Inherited from FormEngineUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyWatermarkCssClass
The CSS class to apply to the TextBox when it has no value (e.g. the watermark text is shown).
Public propertyWatermarkText
The text to show when the control has no value.
Public propertyWhereConditionFormat
Format of where condition.
(Inherited from FormEngineUserControl.)
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.)
Protected methodConnectToForm
Connects the given form control to a form if necessary
(Inherited from FormEngineUserControl.)
Protected methodContainsColumn
Indicates if form control's DataRow contains requested column.
(Inherited from FormEngineUserControl.)
Protected methodConvertInputValue
Ensures that the given value is represented as null is empty, or converted to proper type.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Protected methodGetColumnValue
Gets the given column value from the form data
(Inherited from FormEngineUserControl.)
Public methodGetControlInfoMarker
Gets the control info marker code
(Inherited from FormEngineUserControl.)
Protected methodGetDialogConfiguration
Returns dialog configuration from the specified form control settings.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Public methodGetOtherValues
Returns an array of values of any other fields returned by the control.
(Inherited from FormEngineUserControl.)
Public methodGetResolvedValueReturnType
Gets resolved property value
(Inherited from FormEngineUserControl.)
Public methodGetSpellCheckFields
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
(Overrides FormEngineUserControlGetSpellCheckFields.)
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
(Inherited from FormEngineUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Public methodIsValid
Returns true if user control is valid.
(Overrides FormEngineUserControlIsValid.)
Public methodLoadControlFromFFI
Loads control with values in FormFieldInfo.
(Inherited from FormEngineUserControl.)
Public methodLoadControlValue
Loads control value.
(Inherited from FormEngineUserControl.)
Public methodLoadDefaultProperties
Loads the default properties from the given form definition
(Inherited from FormEngineUserControl.)
Public methodLoadOtherValues
Loads the other fields values to the state of the form control
(Inherited from FormEngineUserControl.)
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
Init event handler
(Overrides FormEngineUserControlOnInit(EventArgs).)
Protected methodOnLoad
Load event handler
(Overrides AbstractUserControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler
(Overrides AbstractUserControlOnPreRender(EventArgs).)
Protected methodRaiseOnChanged
Raises the Changed event.
(Inherited from FormEngineUserControl.)
Public methodReloadControl
Reloads form control content.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Protected methodRender
Renders user control.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Public methodSetValue(String, Object, Boolean)
Sets the property value of the control, setting the value affects only local property value.
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Protected methodUnderlyingFormControl_Changed
Changed handler.
(Inherited from FormEngineUserControl.)
Public methodValidateMacroValue
Returns true if the given macro value is valid value for this control
(Inherited from FormEngineUserControl.)
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.
(Inherited from FormEngineUserControl.)
Top
See Also