sc-note-box

1 Purpose

This document is a user guide for the sc-note-box component as of version 5.11.

sc-note-box places a note box field on a form, allowing the user to enter of lines of text. The default height of a note box field is 3 lines. The note box field automatically scrolls if more than 3 lines of text are entered. A drag handle on the bottom right corner allows the user to manually increase the height of the note box.

The sc-note-box definition provides fields for setting the properties of a note box field and is fully described below.

2 Definition

sc-note-box is defined by a set of name/value pair fields consisting of:

• Required system fields
• Required customizable fields
• Optional customizable fields

Note:

1. Default values for fields described in the tables below are shown in bold text.

2.1 Required System Fields

2.2 Required Customizable Fields

2.3 Optional Customizable Fields

3 Typical Definition

Below is a typical sc-note-box definition, defined with its required fields plus any optional field whose value is typically other than its default value.

{
    "componentName": "sc-note-box",
    "label": "Test sc-note-box",
    "name": "testScNoteBox",
    "fullWidth":true
}

One or more of the optional fields shown below can be included in the above definition should a value other than their default value be required.

    "mandatory": true,
    "defaultValue": "This is the default Note",
    "displayCharacterCount": true,
    "disableSave":true,
    "enabled":false,
    "limitCharacterCount": 100,
    "noteBoxRows": 10,
    "visible":false,
    "visualCharacterCount": true,

4 Examples

Example 1

Below is a typical sc-note-box definition, defined with its required fields plus any optional field whose value is typically other than its default value.

        {
            "componentName": "sc-note-box",
            "name": "testScNoteBox",
            "label": "Test sc-note-box",
            "fullWidth": true
        }

Resulting field on the form:

Resulting field on the form after entered a value in the note box field:

This sc-note-box field was defined without a noteBoxRows value and hence its display height will default to 3 rows. In the images immediately above and below, the note box drag handle was used to manually resize the note box in order to reveal all entered rows.

Resulting field on the form after saving the entered value:

Resulting field in the document and database after saving the entered value:

Horizontally scroll the image below to view the entire saved value, noting that on save, each new line is automatically prefixed with \n.

    "testScNoteBox": "First line of text entered into the note box.\nAnother line of text entered into the note box.\nYet another line of text entered into the note box. However this line is intentionally a very long line of text in order to demonstrate that a line exceeding the width of the note box field displayed on the form will automatically wrap.\nYet another line of text. To enter more lines, clicking enter will scroll the note box OR use the note box drag handle to increase the note box height."