Enterprise Keyboard Manager

Note: To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.

EMDK for Xamarin - 2.6

Overview

Enterprise Keyboard Manager (EnterpriseKeyboard) controls the settings of Enterprise Keyboard, Zebra's soft input device that provides an efficient means of manual input of data into Zebra devices running Android. Building on the stock Android keyboard, Enterprise Keyboard adds programmable keys, switches quickly between languages and key layouts, and can scan data directly into an application.

Enterprise Keyboard also makes use of Android's Personal Dictionary for spelling suggestions and corrections, and permits customers and partners to populate the device with industry-specific terms to help improve the speed and accuracy of keyboard input. A Personal Dictionary can be populated manually or from a file, and can be mass-deployed through Zebra's Mobility Extensions (MX) and StageNow tools. Learn more about the Personal Dictionary.

Also see the Enterprise Keyboard User Guide.

Main Functionality

Enable/Disable:

  • Auto-capitalization
  • Auto-correction
  • Blocking of Offensive Words
  • Keypress Vibration, Sound and Key Pop-ups
  • Suggest Next Word, Spelling Corrections, Personalized Terms and Contacts
  • Display of Alphanumeric, Numeric, Scan and Symbol Tabs
  • Display of Voice Input Key (microphone icon)
  • Use of "Flick" to input shift/long-press characters

Unique Features:

  • Direct scanning of barcodes
  • Swipe, use tabs and/or keys to switch keyboard layouts
  • Set a preferred tab to appear whenever keyboard is invoked
  • Easily switch between calculator, phone and other layouts
  • Single-tap to switch languages
  • Remap keys to create custom layouts
  • Color scheme easily readable indoors and out
  • Auto-hide suggestion bar for optimal screen usage

Included languages:

  • English (UK)
  • English (US)
  • French
  • German
  • Italian
  • Spanish
  • Russian

About Tab-key Navigation

The Enterprise Keyboard Tab key is designed to move the cursor or UI focus from one text field or UI component to the next. Zebra recommends that apps be built to use the Tab key to navigate in this way. On devices with versions prior to MX 6.2 and/or Enterprise Keyboard 1.3, the Tab key might not move the cursor as expected. For help with native-app navigation, please refer to the Android Tab-key navigation section of the Android developer docs.

Auto-capitalization Enable/Disable

Controls whether to capitalize the first word of each sentence following a period.

Parm Name: AutoCapitalization

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Enterprise Keyboard to perform Auto-capitalization.

MX: 6.0+

2 Turn off Disables the Auto-capitalization feature.

MX: 6.0+

Auto-correction Enable/Disable

Controls whether to allow automatic replacement of misspelled words with those found in the Add-on and Personal dictionaries when suggestion for one or more dictionaries is enabled. Suggested replacements are inserted by pressing the spacebar.

Parm Name: AutoCorrection

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Enterprise Keyboard to perform Auto-correction on words spelled incorrectly.

MX: 6.0+

2 Turn off Disables the Auto-correction feature.

MX: 6.0+

Block Offensive Words Enable/Disable

Controls whether to the display as suggested spelling corrections words that might be deemed offensive or insensitive as determined by external standards of decency.

Parm Name: BlockOffensiveWords

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Activates Google's routines for blocking offensive words as spelling suggestions.

MX: 6.0+

2 Turn off Disables the Block Offensive Words feature, allowing all spelling suggestions to be shown.

MX: 6.0+

Double-Space Period Enable/Disable

Controls whether to automatically insert a period and space when double-tapping the spacebar.

Parm Name: DoubleSpacePeriod

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Enterprise Keyboard to perform Double-Space Period function.

MX: 6.0+

2 Turn off Disables the Double-Space Period function.

MX: 6.0+

Key Long-Press Delay Mode

Controls whether to specify the length of time (in ms) a key must be held down before being considered a long-press (default = 300ms), or to leave the setting unchanged. When "Specify duration" is selected, the long-press delay is set using the "KeyLongPressDelay" parameter.

Parm Name: KeyLongPressDelayMode

Option Name Description Note Requires
0 Do not change A null value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Specify duration Enables specification of the length of time (in ms) that a key must be held before being considered a long press.

MX: 6.0+

Flick Enable/Disable

Controls whether a finger "flick" can be used to input characters otherwise accessible by using the shift key or a long-press.

Parm Name: Flick

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.1+

1 Turn on Enables a finger flick to input alternate characters.

MX: 6.1+

2 Turn off Disables finger flick for character input.

MX: 6.1+

Key Long-Press Delay

Controls the length of time (in ms) a key must be held down before being considered a long-press (default = 300ms).

Parm input rules:

  • Accepts an integer between 100 and 700 (ms)

Shown if: Key Long-Press Delay Mode is set to "Specify duration"

Parm Name: KeyLongPressDelay

Requires:

  • MX: 6.0+

Keypress Sound Volume Mode

Controls whether to specify the sound volume (as a percentage of the maximum) or to accept the System setting (default).

Parm Name: KeypressSoundVolumeMode

Option Name Description Note Requires
0 Do not change A null value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Specify volume Enables keypress sound volume (as a percentage of the maximum) to be specified.

MX: 6.0+

2 System default Accepts the System setting for the keypress sound volume.

MX: 6.0+

Set Keypress Sound Volume

Allows the sound volume for each keypress to be speficied as a percentage of the maximum.

Parm input rules:

  • Accepts an integer between 0 and 100 (%)

Shown if: Keypress Sound Volume Mode is set to "Specify duration"

Parm Name: KeypressSoundVolume

Requires:

  • MX: 6.0+

Keypress Vibration Duration Mode

Controls whether to specify the length of time (in ms) to operate device vibration when a key is pressed or to accept the System setting.

Parm Name: KeypressVibrationDurationMode

Option Name Description Note Requires
0 Do not change A null value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Specify duration Enables a vibration duration (in ms) to be specified for each keypress.

MX: 6.0+

2 System default Accepts the System setting for the keypress vibration duration.

MX: 6.0+

Next Word Suggestions Enable/Disable

Controls whether to Enterprise Keyboard will suggest possible next words based on the word being typed or most recently entered. This feature is sometimes referred to as "Predictive text."

Parm Name: NextWordSuggestions

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Enterprise Keyboard to suggest the next word to be entered based on the most recent word entered.

MX: 6.0+

2 Turn off Disables the suggestion of the next word to be entered based on the most recent word entered.

MX: 6.0+

Keypress Vibration Duration

Used to specify the length of time (from 0 to 100ms) that the device will vibrate to indicate that a key has been pressed (default = 0ms).

Parm input rules:

  • Accepts an integer between 0 and 100

Shown if: Keypress Vibration Duration Mode is set to "Specify duration"

Parm Name: KeypressVibrationDuration

Requires:

  • MX: 6.0+

Personalized Suggestions Enable/Disable

Controls whether Enterprise Keyboard will suggest words and terms that have been previously entered and stored in the Personal Dictionary. Suggested words will appear as spelling corrections for words as they are being typed. Enable Auto-correction to accept suggested words by pressing the space bar.

Parm Name: PersonalizedSuggestions

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Enterprise Keyboard to display personalized spelling suggestions from the Personal Dictionary.

MX: 6.0+

2 Turn off Disables suggestions for spelling corrections from the Personal Dictionary.

MX: 6.0+

Pop-up On Keypress Enable/Disable

Controls whether a "big character bubble" will pop up when a key on the Enteprise Keyboard is pressed.

Parm Name: PopupOnKeypress

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Popup On Keypress feature.

MX: 6.0+

2 Turn off Disables the Popup On Keypress feature.

MX: 6.0+

Show Correction Suggestions Enable/Disable

Controls whether Enterprise Keyboard will display spelling correction suggestions for words being typed. Enable Auto-correction to accept suggested words by pressing the space bar.

Parm Name: ShowCorrectionSuggestions

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Enterprise Keyboard to suggest words to replace misspelled or incomplete words as they are typed.

MX: 6.0+

2 Turn off Prevents Enterprise Keyboard from suggesting spelling corrections.

MX: 6.0+

Numeric Layout Mode

Permits selection of the Numeric keypad layout.

Note: Enabling the Numeric tab disables remapping of the Alphanumeric P1 key.

Parm Name: NumericLayoutMode

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.1+

1 Telephone mode Enables Telephone keypad mode.

MX: 6.1+

2 Calculator mode Enables Calculator keypad mode.

MX: 6.1+

Alphanumeric Tab Show/Hide

Controls whether to display the alphanumeric tab among other selected keyboard layout tabs. Note: Hiding this tab prevents the alphanumeric key layout from being selected by the device user.

Parm Name: ShowAlphaNumericTab

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 7.1+

1 Turn on Shows the alphanumeric tab among the other key layout tabs.

MX: 7.1+

2 Turn off Hides the alphanumeric tab and prevents selection of the alphanumeric key layout.

MX: 7.1+

Controls the means of navigating between keyboard layouts. "Tabs" mode permits switching layouts by swiping the key layout in either direction or by tapping directly on the desired tab. The tab bar will be visible at all times except when next-word suggestions (if enabled) are being displayed. "Keys" mode permits specific keys to be used to switch layouts, as with the default Android keyboard. However, this mode prevents certain keys from being remapped and overrides any previous assignment, mapping those keys to their respective keyboard layouts. See important notes, below.

Remapping Notes:

  • In "Keys" mode:
    • Numeric P3 and P4, Alpha P1 and Symbol P1 keys are mapped to keyboard layouts; custom remapping for these keys is disabled.
    • Numeric P1 and P2 remain remappable.
  • Enabling the Alpha tab disables remapping of the Numeric P4 key.
  • Enabling the Numeric tab disables remapping of the Alphanumeric P1 key.
  • Enabling the Symbol tab disables remapping of the Numeric P3 key.
  • When the Symbol, Alpha or Numeric tab is disabled, the last-saved key remapping assignment for the corresponding key (if any) is restored.

Behavior Notes:

  • If either the tab bar or the suggestion bar are enabled, both appear.
  • The tab bar does not appear if the Next Word Suggestions bar and the Voice Input Key are both disabled.
  • On GMS devices, if voice is enabled and the next-word suggestions feature is disabled, a blank suggestion bar appears over the tab bar when words are being suggested.
  • If the TYPE_TEXT_FLAG_NO_SUGGESTIONS input type is enabled, neither the tab bar nor the suggestion bar appears. About Android input types.

Parm Name: NavigationMode

Option Name Description Note Requires
1 Tabs Enables tab-based navigation for switching between keyboard layouts.

MX: 7.1+

2 Keys Enables key-based navigation for switching between keyboard layouts.

MX: 7.1+

Numeric Tab Show/Hide

Controls whether to display the numeric tab among other selected keyboard layout tabs.

Notes:

  • Enabling this tab disables remapping of the Alphanumeric P1 key.
  • Hiding this tab prevents the numeric key layout from being selected by the device user.

Parm Name: ShowNumericTab

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 7.1+

1 Turn on Shows the numeric tab among the other key layout tabs.

MX: 7.1+

2 Turn off Hides the numeric tab and prevents selection of the numeric key layout.

MX: 7.1+

Preferred Tab

Used to specify the tab to appear when EKB is invoked for text input.

Parm Name: SelectPreferTab

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 7.1+

1 Numeric Causes the numeric layout to appear whenever EKB is invoked.

MX: 7.1+

2 Alpha numeric Causes the alphanumeric layout to appear whenever EKB is invoked.

MX: 7.1+

3 Symbol Causes the symbol layout to appear whenever EKB is invoked.

MX: 7.1+

4 Scan Causes the scan tab to appear whenever EKB is invoked.

MX: 7.1+

Symbol Tab Show/Hide

Controls whether to display the symbol tab among the other keyboard layout tabs. Hiding this tab prevents the symbol key layout from being selected by the device user.

Note: Enabling the Symbol tab disables remapping of the Numeric P3 key.

Parm Name: ShowSymbolTab

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 7.1+

1 Turn on Shows the symbol tab among other key layout tabs.

MX: 7.1+

2 Turn off Hides the symbol tab and prevents selection of the symbol key layout.

MX: 7.1+

Scan Tab Show/Hide

Controls whether to display the scan tab among the other keyboard layout tabs. The scan tab displays the scanner controls for collecting barcode data. Scanning from within Enterprise Keyboard requires the DataWedge service to be enabled on the device.

Note: The scan tab is disabled whenever a scanning app is running.

Parm Name: ShowScanTab

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Shows the scan tab for activating the device scanner.

MX: 6.0+

2 Turn off Hides the scan tab.

MX: 6.0+

Sound On Keypress Enable/Disable

Controls whether to play a sound when a key is pressed. To control volume of Keypress sound, see Keypress Sound Volume.

Parm Name: SoundOnKeypress

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Sound On Keypress feature.

MX: 6.0+

2 Turn off Disables the Sound On Keypress feature.

MX: 6.0+

Suggest Contact Names Enable/Disable

Controls whether to automatically display contacts from the device contact list when typing names. This feature works only with specific field types.

Parm Name: SuggestContactNames

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables Enterprise Keyboard to suggest contact names from contacts stored on the device as they're being typed.

MX: 6.0+

2 Turn off Disables the suggestion of contact names from contacts stored on the device as they're being typed.

MX: 6.0+

Vibrate On Keypress Enable/Disable

Controls whether to activate device vibration (haptic feedback) when a key is pressed. To control the length of time the device will vibrate, see Keypress Vibration Duration.

Shown if: Vibrate on Keypress is set to "Enable"

Parm Name: VibrateOnKeypress

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Enables vibration (haptic feedback) when a key is pressed.

MX: 6.0+

2 Turn off Disables vibration (haptic feedback) when a key is pressed.

MX: 6.0+

Voice Input Key Enable/Disable

Controls whether to display the voice input key, which contains a microphone icon. When enabled, will display a key for allowing Enterprise Keyboard to accept spoken input using the device microphone. This feature is visible on GMS-enabled devices only.

Notes:

  • The tab bar will not appear if both the Next Word Suggestions bar and Voice Input Key are disabled.
  • On GMS devices, if voice is enabled and the next-word suggestions feature is disabled, a blank suggestion bar will appear over the tab bar when words are being suggested.
  • If the TYPE_TEXT_FLAG_NO_SUGGESTIONS input type is enabled in the app, neither the tab bar nor the suggestion bar will appear. About Android input types.

Parm Name: VoiceInputKey

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained.

MX: 6.0+

1 Turn on Causes the Voice Input Key (mic) to be shown.

MX: 6.0+

2 Turn off Hides the Voice Input Key (mic).

MX: 6.0+

Remap Alpha Key P1

Used to specify a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 4, Column 1. If this field is left blank, no change is made and any previously selected value is retained.

Notes:

  • Enabling the Numeric tab disables remapping of the Alphanumeric P1 key.
  • Remapping of this key is disabled when "Keys" is selected as the Navigation mode.

Parm input rules:

  • A string from 0–8 characters
  • A UNICODE value (\uXXXXXX) corresponding to the desired key
  • The actual character to be substituted

Parm Name: RemapAlphaP1

Requires:

  • MX: 6.0+

Remap Numeric Key P1

Used to specify a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 1, Column 1. If this field is left blank, no change is made and any previously selected value is retained.

Parm input rules:

  • A string from 0–8 characters
  • A UNICODE value (\uXXXXXX) corresponding to the desired key
  • The actual character to be substituted

Parm Name: RemapNumericP1

Requires:

  • MX: 6.0+

Remap Numeric Key P2

Used to specify a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 2, Column 1. If this field is left blank, no change is made and any previously selected value is retained.

Parm input rules:

  • A string from 0–8 characters
  • A UNICODE value (\uXXXXXX) corresponding to the desired key
  • The actual character to be substituted

Parm Name: RemapNumericP2

Requires:

  • MX: 6.0+

Remap Numeric Key P3

Used to specify a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 3, Column 1. If this field is left blank, no change is made and any previously selected value is retained.

Notes:

  • Enabling the Symbol tab disables remapping of the Numeric P3 key.
  • Remapping of this key is disabled when "Keys" is selected as the Navigation mode.

Parm input rules:

  • A string from 0–8 characters
  • A UNICODE value (\uXXXXXX) corresponding to the desired key
  • The actual character to be substituted

Parm Name: RemapNumericP3

Requires:

  • MX: 6.0+

Remap Numeric Key P4

Used to specify a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 4, Column 1. If this field is left blank, no change is made and any previously selected value is retained.

Notes:

  • Enabling the Alpha tab disables remapping of the Numeric P4 key.
  • Remapping of this key is disabled when "Keys" is selected as the Navigation mode.

Parm input rules:

  • A string from 0–8 characters
  • A UNICODE value (\uXXXXXX) corresponding to the desired key
  • The actual character to be substituted

Parm Name: RemapNumericP4

Requires:

  • MX: 6.0+

Remap Symbol Key P1

Used to specify a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Symbol Keypad Row 4, Column 1. If this field is left blank, no change is made and any previously selected value is retained.

Notes:

  • Enabling the Alphanumeric tab disables remapping of the Symbol P1 key.
  • Remapping of this key is disabled when "Keys" is selected as the Navigation mode.

Parm input rules:

  • A string from 0–8 characters
  • A UNICODE value (\uXXXXXX) corresponding to the desired key
  • The actual character to be substituted

Parm Name: RemapSymbolP1

Requires:

  • MX: 8.0+