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

From SmartWiki
Jump to: navigation, search
Line 1: Line 1:
 
==General Description==
 
==General Description==
 
 
Text box consisting of one or more lines of text.
 
Text box consisting of one or more lines of text.
  
Line 9: Line 8:
 
'' '''Text - Multiple Lines''' custom field, in View Mode (above)''
 
'' '''Text - Multiple Lines''' custom field, in View Mode (above)''
  
{{FieldOptions}}
+
==Field Options==
 +
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.
 +
 
 
* '''Default Text''': The default text that will appear in the text box
 
* '''Default Text''': The default text that will appear in the text box
: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]]
 
{{ToolTip}}
 
{{HideFieldForNewRecord}}
 
{{SmartFieldView}}
 
  
 
+
: 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]]
{{OptionsTab}}
 
{{AllowEmpty}}
 
{{AppearMandatory}}
 
{{Searchable}}
 
{{TrackChanges}}
 
{{EnableKML}}
 
{{DisableQuickEdit}}
 
{{DisableFromGlobalSearch}}
 
{{EnableMapService}}
 
 
* '''ReadOnly''':
 
* '''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.
 
* '''[[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 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.  
+
* '''History time format''': This option will allow formatting of the time format in the history. Only exposed when Enable Note Entry Mode is set.
  
  
Line 35: Line 28:
  
 
{{MaximumLength}}
 
{{MaximumLength}}
 
 
==Formatting==
 
{{FieldFormattingOptions}}
 
 
 
==Value Storage==
 
{{ValueStoresTo}}
 
 
  
 
==Note Entry mode==
 
==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.  
+
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.  
+
The history section will show the name of the user who entered the value and a time-stamp of when the value was entered.
  
 
[[Image:EnableNoteEntry1.png|1100px|border]]
 
[[Image:EnableNoteEntry1.png|1100px|border]]
 
 
{{CFPermissionsTab}}
 
  
  

Revision as of 17:58, 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.


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
  • 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