Difference between revisions of "Custom Field Type: Text Box - Email"

From SmartWiki
Jump to: navigation, search
Line 7: Line 7:
  
 
==Field Illustrated==
 
==Field Illustrated==
[[Image:placeholder.png|''Text Box - Email, in Edit Mode (above)'']]<br />
+
[[Image:placeholder.png|<em>Text Box - Email, in Edit Mode (above)</em>]]<br />
 
''Text Box - Email, in Edit Mode (above)''
 
''Text Box - Email, in Edit Mode (above)''
  
==General Settings==
+
==Field Options==
===General===
+
All common options:<br />
{| class="wikitable"
+
[[Custom Fields - General Information #General_Settings|General Settings]]<br />
|-
+
[[Custom Fields - General Information #Role Field Permissions and Status Field Permissions|Permissions & Availability]]<br />
!|Option
+
[[Custom Fields - General Information #Classic Options|Classic Options]]<br />
!|Description
+
For further information, please refer to [[Custom Fields – General Information]].<br /><br />
!|Format
+
Options listed below are specific to this particular field type.
|-
+
 
!|Custom Field ID 
+
 
||The ID number associated with the custom field.
 
||''Not Applicable''
 
|-
 
!|Field Type
 
||The list of available Field Types
 
||@fieldtype@
 
|-
 
!|Field Name
 
||The name of the field, used internally to reference the user's input.
 
||@fieldname@
 
|-
 
!|[[Caption]] 
 
||The leading question or prologue before the field. If left blank, the Field Name will be displayed as the caption.
 
||@caption@
 
|-
 
!|Display Order 
 
||The order (relative to other fields) in which this field is displayed.
 
||@displayorder@
 
|-
 
!|Description
 
||Definition and general description of the custom field. Will not be displayed.
 
||@description@
 
|}
 
===Display===
 
{| class="wikitable"
 
|-
 
!|Option
 
!|Description
 
!|Format
 
|-
 
!|Caption Location 
 
||Determines the positioning and visibility of the [[caption]] relative to the field. Options include: Left of Field, Above Field, No Caption, Hide Caption. '''Note:''' this option was previously called '''Label Display'''. ([[Label Display Options|See examples here.]])
 
||''Not Applicable''
 
|-
 
!|Instructions
 
||Text input here displays under the caption. If caption has Hide Caption enabled then any defined instructions will continue to be displayed above the input.
 
||''Not Applicable''
 
|-
 
!|Placeholder Text
 
||Text input here displays within the text box as placeholder text that will disappear once the user clicks into the field to enter content. Note: this function is different from Default Text, as Placeholder text will not create content to be stored within the field.
 
||''Not Applicable''
 
|-
 
!|[[Tool Tip]]
 
||When the user hovers their mouse pointer over the caption of a field, the text in this section will appear.
 
||''Not Applicable''
 
|-
 
!|Classify as Personal Data
 
||For use in storing personal data.
 
||''Not Applicable''
 
|-
 
!|SmartFields View
 
||Include or exclude this field from SmartField Views (@SmartFields@) or only display this field for SmartField Views. See SmartField View for further details.
 
||''Not Applicable''
 
|-
 
!|SmartFields PDF Formatting
 
||PDF formatting option when rendered from SmartFields Views.
 
||@SmartFields@
 
|}
 
===Formatting===
 
{| class="wikitable"
 
|-
 
!|Option
 
!|Description
 
!|Format
 
|-
 
!|Width
 
||Width of text box.
 
||''Not Applicable''
 
|}
 
===Validation===
 
{| class="wikitable"
 
|-
 
!|Option
 
!|Description
 
!|Format
 
|-
 
!|Mandatory
 
||Selecting this option means that this field is required and must be completed.
 
||''Not Applicable''
 
|-
 
!|Appear Mandatory
 
||Makes the field appear as though it is a required field. Typically used in conjunction with browser scripts, JavaScript Validation or Submit Logic that perform validation.
 
||''Not Applicable''
 
|-
 
!|Custom Validation
 
||-
 
||''Not Applicable''
 
|-
 
!|Failed Validation Message
 
||Message displayed if validation fails.
 
||''Not Applicable''
 
|}
 
===Feature Options===
 
{| class="wikitable"
 
|-
 
!|Option
 
!|Description
 
!|Format
 
|-
 
!|Track Changes
 
||-
 
||''Not Applicable''
 
|}
 
===Value Storage===
 
{| class="wikitable"
 
|-
 
!|Option
 
!|Description
 
!|Format
 
|-
 
!|From Custom Field(s)
 
||-
 
||''Not Applicable''
 
|-
 
!|To Custom Field
 
||-
 
||''Not Applicable''
 
|}
 
 
[[Category:Custom Fields]]
 
[[Category:Custom Fields]]
 
[[Category:Custom Field Types]]
 
[[Category:Custom Field Types]]

Revision as of 18:50, 21 November 2018

Construction warning.png Please note that this page is currently under construction. There is more information to come.


General Description

Text box for email addresses.

Field Illustrated

Text Box - Email, in Edit Mode (above)
Text Box - Email, in Edit Mode (above)

Field Options

All common options:
General Settings
Permissions & Availability
Classic Options
For further information, please refer to Custom Fields – General Information.

Options listed below are specific to this particular field type.