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

From SmartWiki
Jump to: navigation, search
(→‎Display)
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
The '''Number Format''' setting on [[Custom Fields]] allows you to define how numbers in the field will be displayed.
 
−
 
 
==General Description==
 
==General Description==
−
Text box for email addresses.
+
The '''Text Box - Number''' field allows you to define how numbers in the field will be displayed.
  
 
==Field Illustrated==
 
==Field Illustrated==
−
[[Image:placeholder.png|<em>Text Box - Email, in Edit Mode (above)</em>]]<br />
+
[[Image:placeholder.png]]<br />
−
''Text Box - Email, in Edit Mode (above)''
+
''Text Box - Number, in Edit Mode (above)''
 +
 
 +
==FieldOptions==
 +
All common options:<br />
 +
[[Custom Fields - General Information #General_Settings|General Settings]]<br />
 +
[[Custom Fields - General Information #Role Field Permissions and Status Field Permissions|Permissions & Availability]]<br />
 +
[[Custom Fields - General Information #Classic Options|Classic Options]]<br />
 +
For further information, please refer to [[Custom Fields – General Information]].<br /><br />
 +
Options listed below are specific to this particular field type.
 +
 
 +
===Number Format===
  
−
==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@
 
−
|-
 
−
!|Width
 
−
||Width of text box.
 
−
||''Not Applicable''
 
−
|}
 
−
====Number Format====
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 90: Line 22:
 
!|Value (Example)
 
!|Value (Example)
 
!|Display (Example)
 
!|Display (Example)
 +
|-
 +
!|None
 +
||123456.51
 +
||123456.51
 
|-
 
|-
 
!|Integer
 
!|Integer
Line 120: Line 56:
 
|}
 
|}
  
−
===Validation===
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
!|Option
+
!|Number Precision
−
!|Description
+
!|Value (Example)
−
!|Format
+
!|Display (Example)
 
|-
 
|-
−
!|Mandatory
+
!|Whole Number
−
||Selecting this option means that this field is required and must be completed.
+
||1234.1234
−
||''Not Applicable''
+
||1234
 
|-
 
|-
−
!|Appear Mandatory
+
!|One Decimal
−
||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.
+
||1234.1234
−
||''Not Applicable''
+
||1234.1
 
|-
 
|-
−
!|Custom Validation
+
!|Two Decimals
−
||-
+
||1234.1234
−
||''Not Applicable''
+
||1234.12
 
|-
 
|-
−
!|Failed Validation Message
+
!|Three Decimals
−
||Message displayed if validation fails.
+
||1234.1234
−
||''Not Applicable''
+
||1234.123
−
|}
 
−
===Feature Options===
 
−
{| class="wikitable"
 
 
|-
 
|-
−
!|Option
+
!|Four Decimals
−
!|Description
+
||1234.1234
−
!|Format
+
||1234.1234
 
|-
 
|-
−
!|Track Changes
+
!|Nearest Ten
−
||-
+
||1234
−
||''Not Applicable''
+
||1230
−
|}
 
−
===Value Storage===
 
−
{| class="wikitable"
 
 
|-
 
|-
−
!|Option
+
!|Nearest Hundred
−
!|Description
+
||1234
−
!|Format
+
||1200
 
|-
 
|-
−
!|From Custom Field(s)
+
!|Nearest Thousand
−
||-
+
||1234
−
||''Not Applicable''
+
||1000
−
|-
 
−
!|To Custom Field
 
−
||-
 
−
||''Not Applicable''
 
 
|}
 
|}
 +
 
[[Category:Custom Fields]]
 
[[Category:Custom Fields]]
 
[[Category:Custom Field Types]]
 
[[Category:Custom Field Types]]
−
 
−
 
  
 
<!--[[Image:PrecisionSetting.png|link=]]
 
<!--[[Image:PrecisionSetting.png|link=]]
 
[[Image:NewNumberFormatting.png|link=]]-->
 
[[Image:NewNumberFormatting.png|link=]]-->
−
 
−
 
−
: {| 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)
 
−
 
−
 
−
 
 
===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 "Apply 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 194: Line 111:
 
* [[Displaying a Number Value as Currency]]
 
* [[Displaying a Number Value as Currency]]
 
* [[The Musings of Chin - Best Practice: Correct Data Formats]]
 
* [[The Musings of Chin - Best Practice: Correct Data Formats]]
−
 
−
{| class="wikitable"
 
−
|-
 
−
||[[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.
 
−
|}
 
  
 
[[Category:Custom Fields]][[Category:Currency]][[Category:How]]
 
[[Category:Custom Fields]][[Category:Currency]][[Category:How]]

Latest revision as of 19:21, 21 November 2018

General Description

The Text Box - Number field allows you to define how numbers in the field will be displayed.

Field Illustrated

File:Placeholder.png
Text Box - Number, in Edit Mode (above)

FieldOptions

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.

Number Format

Number Format Value (Example) Display (Example)
None 123456.51 123456.51
Integer 123456.51 123,457
Comma 123456.51 123,457
Decimal 123456.51 123,456.51
Currency (US Dollars)  123456.51 $123,456.51
Percent (Decimal) 0.5199 52%
Percent (Display Number) 51.99 52%
Custom Not Applicable Not Applicable
Number Precision Value (Example) Display (Example)
Whole Number 1234.1234 1234
One Decimal 1234.1234 1234.1
Two Decimals 1234.1234 1234.12
Three Decimals 1234.1234 1234.123
Four Decimals 1234.1234 1234.1234
Nearest Ten 1234 1230
Nearest Hundred 1234 1200
Nearest Thousand 1234 1000

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 "Apply 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

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Custom_Field_Type:_Text_Box_-_Number&oldid=33639’