QR Code form control

A form control that shows a QR code on an eForm a runtime app user can scan with a camera.


QR Code form control

Configure the QR Code form control

To configure the QR Code QR Code icon control, do the procedure in this topic.

Video: Common Configuration Settings in eForm Controls

Prerequisites

How to Start

  1. Open eForm Builder.

    For information about how to open this screen, refer to eForm Builder screen.


    Eform Builder screen
  2. On the eForm Builder screen, in the Toolbox, open the Advanced Controls tab.

    Advanced Controls tab
  3. On the Advanced Controls tab, drag a QR Code QR Code icon form control onto your eForm.

    QR Code form control

General tab - QR Code

Specifies the basic configuration for the QR Code form control.

Figure: General tab

General tab

Fields

Field NameDefinition

Label

Description:
Specifies the text label that shows on your form for the control.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Different for different controls.
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Internal Name

Description:
Specifies a unique, technical name for your control.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
Different for different controls.
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Default Value

Description:
Specifies the data to configure for the QR code.
Allowed Values:
More than one line of text.
Default Value:
None

Help Text

Description:
Specifies the text to shows when a runtime app user hovers their cursor over the form control.
Allowed Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

Help Text Display

Description:
Specifies if the field shows the text in the Help Text field when the runtime app user hovers over the label.
Allowed Values:
  • None - Does not show the help text.
  • Hover On Label - Shows the help text when you put your mouse on the label.
Default Value:
None

Configure tab - QR Code

Configures the settings that are specific to the QR Code form control.

Figure: Configure tab

Configure tab

Fields

Field NameDefinition

QR Code Type

Description:
Specifies the type of data the QR code represents.
Allowed Values:
A data type from the list.
Default Value:
Text

Error Correction Level

Description:
Specifies the error correction level for the QR code to restore data if the code is dirty or damaged.
Allowed Values:
  • 7% - 7% of the data can be restored.
  • 15% - 15% of the data can be restored.
  • 25% - 25% of data the can be restored.
  • 30% - 30% of data the can be restored.
Default Value:
7%

Maximum Length

Description:
Specifies the maximum number of characters permitted in an input field.

The Default Value field on the General tab is the input field for the QR code.

Allowed Values:
An integer.

Range

  • 0-99999
Default Value:
1800

Size (px)

Description:
Specifies the maximum size of the QR code in pixels.
Allowed Values:
An integer.

Range

  • 100-1000
Default Value:
200

Appearance tab - QR Code

Specifies the look and feel for the QR Code form control.

Figure: Appearance tab

Appearance tab

Fields

Field NameDefinition

Font Family

Description:
Specifies the font family of the input text and label.
Allowed Values:
A font name from the list.
Default Value:
None
Example:
Refer to:

Font Size (px)

Description:
Specifies the size of the input text and label for your form control.
Allowed Values:
An integer.

Range

  • Greater than 0
Default Value:
None
Example:
Refer to:

Font Style

Description:
Specifies the style of the font for the input text and label.
Allowed Values:
  • Bold - Shows the input text and label in bold.
  • Underline - Shows the label underlined.
  • Italic - Shows the label in italic.
Default Value:
None
Example:
Refer to:

QR Code Color

Description:
Specifies the QR code color on the form control.
Allowed Values:
A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:
#000000

Foreground Color

Description:
Specifies the foreground color for your control.
Allowed Values:
A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:
#000000
Example:
Refer to:

Container CSS Class

Description:
Specifies a CSS class for the container of your control.
Allowed Values:
A valid CSS class.
Default Value:
None

If you specify your CSS CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Behavior tab - QR Code

Specifies how the QR Code control shows on the eForm.

Figure: Behavior tab

Behavior tab

Fields

Field NameDefinition

Right To Left

Description:
Specifies if the text for this control, including user input, shows from right to left.
Allowed Values:
  • Deselected - The text shows from left to right.
  • Selected - The text shows from right to left.
Default Value:
Deselected
Example:
Refer to:

Visible

Description:
Specifies if the runtime app user sees the field.
Allowed Values:
  • Selected - The runtime app user sees the field.
  • Deselected - The runtime app user does not see the field.
Default Value:
Selected
Example:
Refer to:

Label Position

Description:
Specifies the position of the text label that shows on your form for the control.
Allowed Values:
  • Inherit - The position of the label is as specified in the form settings.
  • Left - Specifies that the position of the label is to the left of the container.
  • Top - Specifies that the position of the label is to the top of the container.
Default Value:
Inherit
Example:
Refer to:

Advanced tab - QR Code

Specifies the advanced settings for the QR Code form control.

Figure: Advanced tab

Advanced tab

Fields

Field NameDefinition

Field ID

Description:
Shows an ID of the control.
Allowed Values:
Read only.
Default Value:
Different for different controls.
Example:
Refer to:

JavaScript Event

Description:
Specifies the JavaScript event that causes an effect.
Allowed Values:
  • None - No action.
  • Blur - When a form user leaves an input field.
  • Change - When a form user changes the content of an input field or selects a value.
  • Click - When the form user clicks a button.
  • Double Click - When the form user double-clicks text.
  • Focus - When an input field gets focus.
  • Keydown - When a form user holds down a key.
  • Keypress - When the form user presses a key.
  • Keyup - When the form user releases a key.
Default Value:
None
Example:
Refer to:

JavaScript Function

Description:
Specifies the name of a JavaScript function to complete the activity.
Allowed Values:
The name of a Javascript function that exists in your app.

For more information, refer to (Example) Use Custom JavaScript in an eForm.

Default Value:
None
Example:

ConfirmSubmission where one of these is your function:

function ConfirmSubmission()
  {
    alert ('Are you sure to submit this form?');
    return true;
  }
function ConfirmSubmission(parameter1,parameter2)
  {
    window.alert ( parameter1 * parameter2);
    
  }

Also refer to:

Download As Image

Description:
Specifies whether to show the Download As Image option on the QR code so the runtime app user can download it as an image.
Allowed Values:
  • Selected - Shows the Download As Image option on the QR code, and runtime app users can download it as an image.
  • Deselected - Hides the Download As Image option on the QR code. The runtime app users can only scan the QR code and can not download it.
Default Value:
Deselected

Show On Tablet Devices

Description:
Specifies if the form field shows on a tablet.
Allowed Values:
  • Selected - The form field shows on a tablet.
  • Deselected - The form field does not show on a tablet.
Default Value:
Selected
Example:
Refer to:

Show On Mobile Phone Devices

Description:
Specifies if the form field shows on a mobile device.
Allowed Values:
  • Selected - The form field shows on a mobile device.
  • Deselected - The form field does not show on a mobile device.
Default Value:
Selected
Example:
Refer to: