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

From SmartWiki
Jump to: navigation, search
Line 31: Line 31:
 
* '''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.  
 +
  
 
{{Validation}}
 
{{Validation}}
 +
 
{{MaximumLength}}
 
{{MaximumLength}}
 
 
  
 
==Formatting==
 
==Formatting==
 
{{FieldFormattingOptions}}
 
{{FieldFormattingOptions}}
 +
  
 
==Value Storage==
 
==Value Storage==
 
{{ValueStoresTo}}
 
{{ValueStoresTo}}
 +
  
 
==Note Entry mode==
 
==Note Entry mode==
Line 49: Line 51:
  
 
[[Image:EnableNoteEntry1.png|1100px|border]]
 
[[Image:EnableNoteEntry1.png|1100px|border]]
 +
  
 
{{CFPermissionsTab}}
 
{{CFPermissionsTab}}

Revision as of 14:55, 19 December 2016

Click here to peruse our selection of custom fields.

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

Option Description Format
Custom Field ID The unique 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. @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@
  • 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
  • Tool Tip: When the user hovers their mouse pointer over the caption of a field, the text in this section will appear.
  • On New Record: Controls how the field should be displayed until record has been saved once.
    • Always Display: Field will be exposed both before and after the record is saved.
    • Hide on New Record: Field will be hidden until record is saved.
    • Only Show on New Record: Field will be exposed until record is saved, and then it will be hidden. This option is useful for fields that provide instructions for filling out forms before saving.
  • SmartField View - Include or exclude this field from SmartField Views (@SmartFields@) or only display this field for SmartField Views. See SmartField View for further details.


Options

General Options

  • Mandatory: Selecting this option means that this field is required and must be completed.
  • 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.
  • Searchable: This field can be searched within the tracking application.
  • Track Changes: Keeps track of changes made to this field.

Enable KML: Used to upload a KML file which is used to display geographic data on a map.

  • Disable Quick Edit: Disables this field from being selectable in Quick Edit on a List View.
  • Disable Field From Global Search: Selecting this option means that the contents of this field will not be displayed in Global Search results.
  • Enable Map Service: Enables the map icon Ps10.jpg that will launch the user’s selected map service (configured in Personal Settings) and display a map of the content of the field.
  • 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

Formatting


Value Storage

  • Value Storage: Enables linking two different custom fields to the same user data. See Value Stores To page.


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


Permissions & Availability Tab


See Also