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

From SmartWiki
Jump to: navigation, search
(32 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
<u>'''General Description'''</u>
+
==General Description==
−
 
 
 
Text box consisting of one or more lines of text.
 
Text box consisting of one or more lines of text.
−
 
−
<u>'''Field Options'''</u>
 
  
−
* '''Allow Empty''': Yes
+
'''Note:''' Field can hold a maximum length of 16,777,215 (2^24 - 1) characters.
−
* '''Default Text''': Yes
 
−
* '''Options''': Default Text
 
−
* '''Track Changes''': Yes
 
−
* '''Store To Value''': Yes
 
−
You can refer to [[Web Page View Field Variables|variables]] as part of the ''Default Text'' as explained in [[Using Variables as Default Values in Single Line and Multi-line Text Box Custom Fields|this article]]
 
−
 
−
<u>'''Special Options for Field'''</u>
 
  
−
* '''Default Text''': The default text that will appear in the text box
+
==Field Illustrated==
−
+
[[Image:Cf_tbml_ex1.png|link=]]<br />
−
<u>'''Services'''</u>
+
'' '''Text - Multiple Lines''' custom field, in View Mode (above)''
  
−
* '''Enable Map Service''': displays the map icon next to the field name that will launch the user’s selected map service and display a map of the content of the field
+
==Field Options==
−
* '''Enable People Search Service''': displays the search Internet icon next to the field name that will launch a variety of search services and display the contact details from those services
+
All common options:<br />
−
* '''Enable Organization Search Service''': displays the search Internet icon next to the field name that will launch a variety of search services and display the organisations details from those services
+
[[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.
  
−
<u>'''Field Validation'''</u>
+
* '''Default Text''': The default text that will appear in the text box
−
 
 
−
* '''Type''': Select Date, Numeric, or Alphabetic validation
 
−
* '''[[JavaScript Validation]]''': Custom JavaScript validation formulas can be entered in this field
 
−
* '''[[Validation Message|Message]]''': The message that the user will see if the data in the field fails a validation check
 
−
* '''Maximum Length''': Sets the maximum length of the text entry. <b>Show Counter</b> determines whether a counter will be shown to the user. <b>Count Words</b> sets the counter to count words (instead of characters, the default).
 
−
* '''Maximum Message''': Message the user will see when they reach the maximum length
 
−
 
 
−
<u>'''Value Stores To'''</u>
 
  
−
* '''Custom Field''': Enables linking two different custom fields to the same user data
+
: You can refer to [[Web Page View Field Variables|variables]] as part of the ''Default Text'' as explained in [[Using Variables as Default Values in Single Line and Multi-line Text Box Custom Fields|this article]]
 +
* '''ReadOnly''':
 +
* '''[[Custom_Field_Type:_Text_–_Multiple_Lines#Note_Entry_mode|Enable Note Entry Mode]]''': When enabled, this will show the history of the previous values saved in the multi-line text field in a table below the field. It will show the name of the user who entered the value and a time-stamp of when the value was entered. When this option is enabled, any value saved in the field will be cleared from the input text area of the field.
 +
* '''History date format''': This option will allow formatting of the date format in the history. Only exposed when Enable Note Entry Mode is set.
 +
* '''History time format''': This option will allow formatting of the time format in the history. Only exposed when Enable Note Entry Mode is set.
  
−
<u>'''Field Formatting Options'''</u>
+
{{MaximumLength}}
  
−
* '''Width''': Determines the width of the field
+
==Note Entry mode==
−
* '''Height''': Determines the height of the field
+
When the Enable Note Entry Mode option is set against the field then, when the page is saved, any value entered against the field will be cleared from the input text area and added to the history section underneath.
−
* '''[[Number Format]]''': Allows you to define how numbers entered in this field will be displayed. See [[Number Format|here]] for details.
 
−
* '''Style''': '''Bold''', <u>Underline</u>, ''Italic'', <font color="red">Highlight</font>
 
−
* '''[[Tool Tip]]''': Enter help text to be shown on mouse-over
 
−
* '''Read Only''': Checkbox
 
−
* '''HTML Tag''': Additional attributes to the field HTML tag
 
−
* '''[[Visibility Condition]]''': Conditions upon which the field is visible
 
  
−
<u>'''[[Role Field Permissions|Role - Field Permissions]]'''</u>
+
The history section will show the name of the user who entered the value and a time-stamp of when the value was entered.
  
−
These [[Role Field Permissions|fields]] allow you to control by [[Role]] who is allowed to view and/or modify the field.
+
[[Image:EnableNoteEntry1.png|1100px|border]]
  
−
<u>'''[[Status Field Permissions|Status - Field Permissions]]'''</u>
 
−
* ''Only present within the [[Universal Tracking Application]]''
 
−
These [[Status Field Permissions|fields]] allow you to control by the [[Status]] of the record whether or not the field can be viewed and/or modified.
 
  
−
Field can hold a maximum length of 16777215 (2^24 - 1) characters.
 
  
 
==See Also==
 
==See Also==
−
* [[Exporting Multiple Line Text Fields to HTML]]
+
* [[Exporting Multiple Lines Text Fields to HTML]]
  
  
−
[[Category:Custom Fields]]
+
{{CustomFieldPageFooter}}

Revision as of 17:59, 23 November 2018

General Description

Text box consisting of one or more lines of text.

Note: Field can hold a maximum length of 16,777,215 (2^24 - 1) characters.

Field Illustrated

Cf tbml ex1.png
Text - Multiple Lines custom field, in View 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.

  • Default Text: The default text that will appear in the text box
You can refer to variables as part of the Default Text as explained in this article
  • ReadOnly:
  • Enable Note Entry Mode: When enabled, this will show the history of the previous values saved in the multi-line text field in a table below the field. It will show the name of the user who entered the value and a time-stamp of when the value was entered. When this option is enabled, any value saved in the field will be cleared from the input text area of the field.
  • History date format: This option will allow formatting of the date format in the history. Only exposed when Enable Note Entry Mode is set.
  • History time format: This option will allow formatting of the time format in the history. Only exposed when Enable Note Entry Mode is set.
  • Maximum Length: Sets the maximum length of the text entry.
    • Show Counter determines whether a counter will be shown to the user.
    • Count Words sets the counter to count words (instead of characters, the default).
  • Exceeded Maximum Message: Message the user will see when they reach the maximum length

Note Entry mode

When the Enable Note Entry Mode option is set against the field then, when the page is saved, any value entered against the field will be cleared from the input text area and added to the history section underneath.

The history section will show the name of the user who entered the value and a time-stamp of when the value was entered.

EnableNoteEntry1.png


See Also

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