CodeCharge Studio All ASP PHP Perl ColdFusion Java C#.NET VB.NET

Text Area Reference

Design-Time Properties

Property Description
Name The name of the control.
Visible Specify whether the control should be displayed or not.
Caption The name used to refer to the control in an error message.
Control Source Type The type of data source that will provide data for the control: Database Column, Code Expression.
Control Source Specify the source of data for the control e.g. the name of a database column.
Data Type The type of data that will be contained in the control.
Format Depending on the Data Type property, select the format of the data that will be contained in the control.
Default Value Specify a default value to be used for the control if no value is otherwise specified.
Required [Yes/No] Select 'Yes' if a value must be entered for the control in order for the form to be submitted successfully.
Unique [Yes/No] Select 'Yes' if you want a check to be made to ensure that any value entered in the control does not already exist in the database.
Input Validation Select a regular expression to be used to check the validity of the data entered in the control.
Error Control Specify the name of a control that will be used to display any error messages pertaining to the control. If this value is not specified, all error messages are displayed at the top of the form in which the control is contained.
Validation Rule Specify an expression that will be used to check the validity of the data entered in the control.
Validation Text Specify the text that will be displayed if the data entered in the control does not meet the validation rule.
DBFormat Specify the format in which you want the control value to be entered into the database.

Events

Event Description
Server Side Events
On Validate Occurs after the control value have been submitted to the server and before the submitted value is used to update any database content. This event is meant to be used to specify any validation operations that should be run against the submitted value to ensure that the value is valid. The addErrors method of the form can be used to log an error if the validation check fails.
Before Show Occurs before the control is rendered to the page. This event can be used to influence the visibility or appearance of the control or alter the value of the control.
Client Side Events
On Key Press Occurs when the user presses an alphanumeric key within the control.
On Load Occurs after the control has been rendered to the page and before the user can perform any operations. This event can be used to bind validation rules to the control.
On Change Occurs when the value of the control is changed.

Run-Time Properties (ASP)

Property Description
Errors An object that contains the error messages generated during script execution when submitted data fails verification or any other user defined condition is not fulfilled.
Format This property specifies a format to be applied to the value of the control.
Visible This property determines whether the component is to be shown or not.
Value Holds the value of the control.

Run-Time Properties (PHP)

Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a textbox that is included within that form.
Errors An object that contains the error messages generated during script execution when submitted data fails verification or any other user defined condition is not fulfilled.
Format This property specifies a format to be applied to the value of the control.
Visible This property determines whether the component is to be shown or not.

Run-Time Properties (.NET)

Interface The System.Web.UI.WebControls.TextBox is used

Property Description
Visible Gets or sets a value that indicates whether the server control is to be rendered as UI on the page.
Text Gets or sets the text for the TextArea control. See .NET Framework SDK reference.

Model Layer

Property Description
<control name> Contains the current value of the control.

Methods (PHP)

Method Description
GetValue Retrieves the value of the control.
SetValue Sets the value for the control.

Run-Time Variables (CF,CFT)

Variable Description
fld<control name> Holds the value of the control.
hide<control name> This variable determines whether the control is to be shown or not.

Methods (Servlets & JSP)

MethodDescription
getPage Get the page that contains this control.
getFormattedValue Get the value formatted according to the control format.
setFormattedValue Use a String to set the control value. The value is taken as is i.e. formatting will not be applied to this value.
getValue Retrieves the value of the control without any formatting applied to it.
setValue This method sets the value of the control.
hasErrors Indicates whether the control has (validation) errors.
addError Add an error description to the errors collection.
getErrorsAsString Return a single String with all the error messages separated by &lt;br&gt; tags.
isVisible Indicates whether this control should be shown.
setVisible Specify whether this control should be shown or not.
getParent Get the parent component that contains this control.

See also

Text Area Overview


On-line, printable versions and updates