Text Input

    Description

    The Text Input asset enables visitors to enter data using either an on-screen or physical keyboard. To see how the Text Input asset can be used to create a form, see the article Create forms for collecting user data at runtime

    When the user selects a Text Input asset, a keyboard is displayed on-screen, permitting the entry of text.

    Configuring the on-screen keyboard used by the Text Input Asset

    Specifying the keyboard language

    IntuiFace support 30+ keyboard languages. Language selection applies to the entire experience and is specified in the Project Settings panel.

    • In Composer, right-click the experience in the Scene Structure panel and select the Show properties option.
    • Select your keyboard language of choice using the "Keyboard language" property.

    The keyboard language can be changed at runtime by calling the Change keyboard layout action associated with the Overall experience in the Triggers and Actions panel.

    keyboard_layout.jpg

    Supported Keyboard languages:

    • Arabic
    • Canadian
    • Chinese Bopomofo
    • Chinese ChaJei
    • Croatian
    • Danish
    • Dutch
    • Finnish
    • French
    • German
    • Greek
    • Hebrew
    • Hindi Traditional
    • Hungarian
    • Italian
    • Japanese Hiragana
    • Korean
    • Latin American
    • Lithuanian
    • Local - Determined by language set on the device
    • Norwegian
    • Persian
    • Polish
    • Portuguese
    • Portuguese Brasilian
    • Romanian
    • Russian
    • Slovak
    • Spanish
    • Swedish
    • Swiss GermanThai Pattachote
    • Turkish
    • US International
    • United Kingdom

    Configuring the keyboard appearance and behavior

    Configuration of the on-screen keyboard occurs in the Text input keyboard category of the Scene property panel. These options will globally affect all onscreen keyboards for all Text Input assets on the same scene.

    To configure the keyboard's appearance for the entire project, change its properties at experience level by selecting the project itself in the scene structure. Setting the properties here, will affect the keyboard across all scenes of your experience.

    • Background color   specify the background color of the keyboard (opacity 0 will make the background invisible)
    • Allow move   toggle whether user can move the keyboard around the display
    • Allow rotate   toggle whether the user can rotate the keyboard; useful for table-mounted displays
    • Allow close   toggle whether the user can manually close the keyboard
    • Show/Hide with animation   toggle whether the keyboard should display and hide with a fade effect
    • Center, x coordinate   on-screen location of the keyboard on the x axis, in pixels
    • Center, y coordinate   on-screen location of the keyboard on the y axis, in pixels
    • Scale factor   size of the keyboard relative to a default scale of 1

    Disable Windows native Virtual Keyboard

    Some of our users reported that the Windows virtual touch keyboard is showing up unexpected even after disabling it from the system tray icon. Follow the steps described below to completely prevent the system virtual keyboard from showing by preventing the virtual keyboard from launching:

    • Open up the Services panel:
      • Press Windows+R on your keyboard and type “services.msc” then hit Enter

    servicesmscwindow.PNG

    • Search for and select Touch Keyboard and Handwriting Panel Service
      • Double click on the service

    serviceswindow.PNG

    • Disable the service and it's automatic startup type
      • In the Properties menu set Startup type to Disabled
      • Click lick on Stop, you should now see the Service status: marked as Stopped
      • Click OK

    Virtualkeyboardservicedisabled.PNG

    After rebooting your machine, the changes you have performed to this service should be permanent.

    Properties, Triggers & Actions

    Properties

    See Common asset properties for details of common properties shared by different assets

    Appearance

    Normal state is the state of the Text Input asset when it is not in focus.

    • Fill color: defines the background color
    • Outline thickness: defines the outline thickness from a scale of 0 to 10
    • Outline color: defines the outline color
    • Outline radius: specifies the roundness of the four corners on a scale of 0 (squared) to 50 (rounded).

    Edit state is the state of the Text Input asset when it has focus.

    • Edit fill color: defines the background color of the Text Input Asset in edit state
    • Edit outline color: defines the outline color of the Text Input Asset in edit state
    • Edit outline thickness: defines the outline thickness of the Text Input Asset in edit state
    • Edit outline radius: specifies the roundness of the four corners on a scale of 0 (squared) to 50 (rounded).

    Selection state refers to the color used to highlight text in the Text Input asset when this asset has focus. - Selection area color: defines the background color of selected text

    Effects See Common asset properties for details about Visibility & Effects properties

    Text

    • Text: text value in the text input asset. Use it to prefill the input field or to access the text entered by a user. You can also modify this text directly in the Scene by double-clicking the Text Input asset.
    • Font, Font size, Font color, Bold, Italic: text style configuration
    • Line wrap: toggles whether entered text will wrap at the end of the line. In addition, if the Trigger Enter key pressed is deleted from the Triggers and Actions panel then, if Line wrap is selected, a press of the Enter key will cause a linefeed to appear within the Text Input field.
    • Horizontal alignment: specify how entered text should be aligned horizontally within the Text Input box
    • Vertical alignment: specify how entered text should be aligned vertically within the Text Input box
    • Margin: minimum separating the left and right borders of the Text Input box and an entered character

    Behavior

    Characters

    • Expected Format: [available when Use regular expression is deselected] specify permitted character types. Invalid characters cannot be entered by the user.
    • Min characters: Minimum number of required characters for a valid entry
    • Max characters: Maximum number of required characters for a valid entry
    • Use custom regular expression: toggle whether you want to use a custom regular expression or prebuilt "Expected format" validation criteria (see next property) to prevent users from entering invalid content
    • Regular expression: [available when Use regular expression is selected] enter a regular expression to determine whether entered text is valid. Invalid characters are determined after the Text Input asset loses focus.
    • Specify keyboard layout: choose whether or not you want IntuiFace to select a keyboard format for you based upon the selected Expected format. If you want to force a keyboard layout, you have two choices:
      • ALPHANUMERIC: an alphanumeric keypad
      • NUMPAD: a numeric keypad

    Password

    • Mask: toggle whether or not you want to mask - i.e. hide - entered characters with an alternate character. Use of the mask would be appropriate for password entry. If selected, two additional properties are revealed:
      • Mask character: the character to be used if masking entered characters
      • Visibility time: length of time, in milliseconds, to display the entered character before replacing with the Mask character

    TextInputProps.jpg

    Triggers

    See Triggers Overview to get details of common triggers shared by all assets or collections

    • Enter key is pressed: Raised when this Text Input asset has focus and the Enter key is pressed on the keyboard (virtual of physical).
    • Is given focus: Raised when this Text Input asset is selected for text entry.
    • Loses focus: Raised when focus moves to a different asset in the scene.
    • Text is updated: Raised every time a character is typed into this Text Input asset. This trigger raises the following parameters:
      • New value
      • Old value

    Validation

    • Identifies an invalid character: Raised as soon as a user types a character outside the scope of the regular expression or expected character format. This trigger raises the following parameter:
      • Invalid character
    • Identifies invalid text: Raised when this Text Input asset loses focus. Occurs when overall text violates expected character format or length presets.
    • Validates the entered text: Raised when this Text Input asset loses focus and the text is found to be valid.

    TextInputTriggers.jpg

    Actions

    See Actions Overview to get details of common actions shared by all assets or collections

    • Empty text field
    • Enter editing mode
    • Exit editing mode
    • Set text
      • New text

    TextInputTAdetails.jpg