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

From SmartWiki
Jump to: navigation, search
(38 intermediate revisions by 8 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.
+
'''Note:''' Field can hold a maximum length of 16,777,215 (2^24 - 1) characters.
+
 
<u>'''Field Options'''</u>
+
==Field Illustrated==
 +
[[Image:Cf_tbml_ex1.png|link=]]<br />
 +
'' '''Text - Multiple Lines''' custom field, in View Mode (above)''
  
* '''Allow Empty''': Yes
+
==Field Options==
* '''Default Text''': Yes
+
All common options:<br />
* '''Options''': Default Text
+
[[Custom Fields - General Information #General_Settings|General Settings]]<br />
* '''Track Changes''': Yes
+
[[Custom Fields - General Information #Role Field Permissions and Status Field Permissions|Permissions & Availability]]<br />
* '''Store To Value''': Yes
+
[[Custom Fields - General Information #Classic Options|Classic Options]]<br />
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]]
+
For further information, please refer to [[Custom Fields – General Information]].<br /><br />
+
Options listed below are specific to this particular field type.
<u>'''Special Options for Field'''</u>
 
  
 
* '''Default Text''': The default text that will appear in the text box
 
* '''Default Text''': The default text that will appear in the text box
 
<u>'''Services'''</u>
 
  
* '''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
+
: 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]]
* '''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
+
* '''ReadOnly''':
* '''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_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 Validation'''</u>
+
{{MaximumLength}}
  
* '''Type''': Select Date, Numeric, or Alphabetic validation
+
==Note Entry mode==
* '''JavaScript Validation''': Here can be entered any specific JavaScript validation for this 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.
* '''[[Validation Message|Message]]''': Message the user will see if entry fails 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>
+
The history section will show the name of the user who entered the value and a time-stamp of when the value was entered.
  
* '''Custom Field''': Enables linking two different custom fields to the same user data
+
[[Image:EnableNoteEntry1.png|1100px|border]]
  
<u>'''Field Formatting Options'''</u>
 
  
* '''Width''': Determines the width of the field
 
* '''Height''': Determines the height of the field
 
* '''Number Format''': Formats any numbers entered into this field
 
* '''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'''</u>
+
==See Also==
 +
* [[Exporting Multiple Lines Text Fields to HTML]]
  
These [[Custom Fields UTA Status Permissions|fields]] allow you to control who is allowed and who is denied viewing and/or modifying the field.
 
  
[[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