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

From SmartWiki
Jump to: navigation, search
Line 1: Line 1:
 
The '''Number Format''' setting on [[Custom Fields]] allows you to define how numbers in the field will be displayed.
 
The '''Number Format''' setting on [[Custom Fields]] allows you to define how numbers in the field will be displayed.
 +
 +
==General Description==
 +
Text box for email addresses.
 +
 +
==Field Illustrated==
 +
[[Image:placeholder.png|<em>Text Box - Email, in Edit Mode (above)</em>]]<br />
 +
''Text Box - Email, in Edit Mode (above)''
 +
 +
==General Settings==
 +
===General===
 +
{| class="wikitable"
 +
|-
 +
!|Option
 +
!|Description
 +
!|Format
 +
|-
 +
!|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@
 +
|-
 +
!|Values
 +
||The value that will be displayed.
 +
||''Not Applicable''
 +
|}
 +
===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 Field Types]]
 +
 +
{| class="wikitable"
 +
|-
 +
!|Number Format
 +
!|Value (Example)
 +
!|Display (Example)
 +
|-
 +
!|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@
 +
|}
  
 
<!--[[Image:PrecisionSetting.png|link=]]
 
<!--[[Image:PrecisionSetting.png|link=]]
 
[[Image:NewNumberFormatting.png|link=]]-->
 
[[Image:NewNumberFormatting.png|link=]]-->
  
−
+
 
−
:{| border="1" cellpadding="5"
+
: {| border="1" cellpadding="5"
−
|+
+
+Number FormatValueDisplay+#,###.##1234.51,234.5+#,###.001234.51,234.50+#.001234.51234.50+Percent.1515%+Integer12.999512+Decimal1212.00+Currency20000$20,000.00+$###,###,###20000$20,000 (currency with no decimals)+Currency-EUR20000€20,000.00+Currency-GBP20000£20,000.00+Currency-QAR20000QAR 20.000,00+T##-#######12345678912-3456789 (EIN)+T### ### ###123 456 789123 456 789 (Canadian SIN)
−
!Number Format!!Value!!Display
+
 
−
|+
 
−
|#,###.##||1234.5||1,234.5
 
−
|+
 
−
|#,###.00||1234.5||1,234.50
 
−
|+
 
−
|#.00||1234.5||1234.50
 
−
|+
 
−
|Percent||.15||15%
 
−
|+
 
−
|Integer||12.9995||12
 
−
|+
 
−
|Decimal||12||12.00
 
−
|+
 
−
|Currency||20000||$20,000.00
 
−
|+
 
−
|$###,###,###||20000||$20,000 (currency with no decimals)
 
−
|+
 
−
|Currency-EUR||20000|| €20,000.00
 
−
|+
 
−
|Currency-GBP||20000|| £20,000.00
 
−
|+
 
−
|Currency-QAR||20000|| QAR 20.000,00
 
−
|+
 
−
|T##-#######||123456789||12-3456789 (EIN)
 
−
|+
 
−
|T### ### ###||123 456 789||123 456 789 (Canadian SIN)
 
−
|}
 
  
  
 
===Notes===
 
===Notes===
−
* The '''Number Format''' setting applies in [[view mode]], or when the values are displayed in a [[Web Page View]], [[Report]], [[MS Word Merge]], [[List View]], etc.  
+
* The '''Number Format''' setting applies in [[view mode]], or when the values are displayed in a [[Web Page View]], [[Report]], [[MS Word Merge]], [[List View]], etc.
−
* Currency formatting will be applied when the record is in [[edit mode]] only if the setting "Show Currency Format in Edit Mode" is selected in the custom field settings.  
+
* Currency formatting will be applied when the record is in [[edit mode]] only if the setting "Show Currency Format in Edit Mode" is selected in the custom field settings.
 
* Any currency defined by [http://en.wikipedia.org/wiki/ISO_4217 ISO 4217] can be shown by using the appropriate three-letter currency code. For example, if ''Currency-JPY'' (for Japanese Yen) is entered into the Number Format setting, the entered value of '''12''' will be displayed as '''￥12'''.
 
* Any currency defined by [http://en.wikipedia.org/wiki/ISO_4217 ISO 4217] can be shown by using the appropriate three-letter currency code. For example, if ''Currency-JPY'' (for Japanese Yen) is entered into the Number Format setting, the entered value of '''12''' will be displayed as '''￥12'''.
  
Line 51: Line 196:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
|[[Image:Why.jpeg|50px|link=]]
+
||[[Image:Why.jpeg|link=|50px]]
−
|Click [http://wiki.smartsimple.com/wiki/Number_-_Why%3F here] to learn why this feature is a benefit to your organization.
+
||Click [http://wiki.smartsimple.com/wiki/Number_-_Why%3F here] to learn why this feature is a benefit to your organization.
 
|}
 
|}
  
 
[[Category:Custom Fields]][[Category:Currency]][[Category:How]]
 
[[Category:Custom Fields]][[Category:Currency]][[Category:How]]

Revision as of 11:20, 23 August 2018

The Number Format setting on Custom Fields allows you to define how numbers in the field will be displayed.

General Description

Text box for email addresses.

Field Illustrated

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

General Settings

General

Option Description Format
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@
Values The value that will be displayed. Not Applicable

Display

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. (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

Option Description Format
Width Width of text box. Not Applicable

Validation

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

Option Description Format
Track Changes - Not Applicable

Value Storage

Option Description Format
From Custom Field(s) - Not Applicable
To Custom Field - Not Applicable
Number Format Value (Example) Display (Example)
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@


+Number FormatValueDisplay+#,###.##1234.51,234.5+#,###.001234.51,234.50+#.001234.51234.50+Percent.1515%+Integer12.999512+Decimal1212.00+Currency20000$20,000.00+$###,###,###20000$20,000 (currency with no decimals)+Currency-EUR20000€20,000.00+Currency-GBP20000£20,000.00+Currency-QAR20000QAR 20.000,00+T##-#######12345678912-3456789 (EIN)+T### ### ###123 456 789123 456 789 (Canadian SIN)

Notes

  • The Number Format setting applies in view mode, or when the values are displayed in a Web Page View, Report, MS Word Merge, List View, etc.
  • Currency formatting will be applied when the record is in edit mode only if the setting "Show Currency Format in Edit Mode" is selected in the custom field settings.
  • Any currency defined by ISO 4217 can be shown by using the appropriate three-letter currency code. For example, if Currency-JPY (for Japanese Yen) is entered into the Number Format setting, the entered value of 12 will be displayed as ￥12.

Important: in edit mode you must use a period (.) as the decimal, even if the currency defined uses a comma (,).

See Also

Why.jpeg Click here to learn why this feature is a benefit to your organization.
Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Custom_Field_Type:_Text_Box_-_Number&oldid=32623’