Differences

This shows you the differences between two versions of the page.

Link to this comparison view

field type - telephone [2016/09/14 14:19] (current)
Line 1: Line 1:
 +====== Telephone ======
 +The Phone Number Field is for storing a telephone or fax number (U.S. and International formats are supported). ​ It can store a country code (when International format is chosen), an area code, an exchange (when U.S. format is chosen), a line number and (optionally) an extension.
 +
 +
 +===== How to Create =====
 +  - Click the {{:​presentation-layer:​field-plus.png|}} to add a field in your [[Form|form]].
 +  - Choose "New Field"
 +  - Select the table you wish to add the field to. Most of the time, this will be the current [[Table|table]] you are on, called the current [[Context|context]].
 +  - Select a field name and click "​Choose Type".
 +  - Choose "Phone Number"​ from the list of field types.
 +  - You can continue adding fields or click the "​Select"​ button to finish adding.
 +===== Features =====
 +
 +Field features can be edited by clicking on the orange field icon {{:​phone.png|}} when the [[Presentation Layer|presentation layer]] is displayed. ​
 +==== Field Label ====
 +  * [[Field Setting - Field Label|Field Label]]
 +  * [[Field Setting - Display Alternate Label]] (affects this form only)
 +
 +==== Grid Appearance ====
 +
 +  * [[Field Setting - Column Span|Column Span]]
 +  * [[Field Setting - Row Span|Row Span]]
 +
 +==== Sizing ====
 +
 +  * [[Field Setting - Sizing|Sizing]]
 +  ​
 +==== Tooltip ====
 +  * [[Field Setting - Tooltip|Tooltip]]
 +  * [[Field Setting - Descriptive Text|Descriptive Text]]
 +  * [[Field Setting - Display Alternate Descriptive Text|Display Alternate Descriptive Text]] (affects this form only)
 +
 +==== Block Association ====
 +  * [[Field Setting - Temporary Block Association|Temporary Block Association]]
 +  * [[Field Setting - Global Block Association|Global Block Association]]
 +
 +==== Default Value ====
 +  * [[Field Setting - Default Value|Default Value]]
 +
 +==== Phone Extension ====
 +  * [[Field Setting - Phone Extension|Phone Extension]]
 + 
 +==== Regionalization ====
 +
 +  * [[Field Setting - Regionalization|Regionalization]]
 +==== Validation ====
 +   * [[Field Setting - Required|Required]]
 +   * [[Field Setting - Maximum Length|Maximum Length]] ​
 +
 +==== Audit History ====
 +  * [[Field Setting - Audit This Field|Audit This Field]] ​
 +  * [[Field Setting - Show Audit History|Show Audit History]]
 +
 +==== View Only ====
 +  * [[Field Setting - View Only|View Only]]
 +
 +===== Field parts =====
 +The Phone Number Field has six parts:
 +
 +  * Phone Number Type - either International or United States.
 +  * Country Code
 +  * Area Code
 +  * Exchange
 +  * Line Number
 +  * Extension  ​
 +===== Output formats =====
 +The Phone Field has eight different output formats:
 +
 +  * Full Field - This output format returns the Area Code enclosed in parentheses (if the Area Code is filled in) followed by a space, then the Exchange, then a hyphen followed by the Line Number. ​ If the Extension is filled in, a ' x' is appended to this number, followed by the Extension (ex. (555) 555-5555 x5555)
 +  * WX Stored Value - This output format returns the internally stored XML for the Phone Number Field. ​ Use this format when saving the entire phone number from one Field to another Phone Number Field, or when setting a default value for a Phone Number Field. ​ Whenever this format is used, the "​Return results as" setting must be set to "​HTML."​
 +  * Phone Number Type - This format returns '​International'​ if the stored number is of the international format and '​United States'​ if the stored number if of the United States format.
 +  * Country Code - This format returns the Country Code part of the Phone Number Field (only applicable if chosen format is International).
 +  * Area Code - This output format returns the Area Code part of the Phone Number Field.
 +  * Prefix - This output format returns the Exchange part of the Phone Number Field (only applicable if chosen format is United States).
 +  * Line Number - This output format returns the Line Number part of the Phone Number Field.
 +  * Extension - This output format returns the Extension part of the Phone Number Field.
 +===== Acceptable inputs =====
 +The phone number field has inherent validation such that when the U.S. format is chosen, if an area code is filled in, the prefix and line number must be filled in, and the area code, prefix and line number must have three, three and four digits, respectively. ​ Also, if any of the remaining parts are filled in, the prefix and line number must be filled in with three and four numbers, respectively. ​ When the International format is chosen, the country code is required, and the line number is required when the area code is filled in.  The extension is always optional.
 +
  
field type - telephone.txt ยท Last modified: 2016/09/14 14:19 (external edit)
Copyright WorkXpress, 2019