Click or drag to resize

PropertyID.VirtualKeyboardProfile Field

Administrative Settings: For devices managed by an organization, administrative policies might require to configure the default virtual keyboard.

Namespace: Com.Datalogic.Device.Configuration
Assembly: datalogic-xamarin-sdk (in datalogic-xamarin-sdk.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
VB
public const Int32 VirtualKeyboardProfile = "value"

Field Value

Type: Int32
Remarks
Administrative Settings: For devices managed by an organization, administrative policies might require to configure the default virtual keyboard.

A virtual keyboard is a software interface that allows users to input text, for example via the device's touchscreen. It appears on the display whenever text input is needed, such as when typing a message, filling out a form, or entering a password.

This parameter allows to configure the desired virtual keyboard among the installed ones. It shall be set as a string representing a valid input method ID.

If the input method ID refers to an input method installed on the device and currently enabled, then this input method will be selected. If the input method ID refers to an input method installed on the device, but currently disabled, then this input method will be both enabled and selected. An empty string is accepted as a valid input method, this means that no input method will be selected for the user.

Setting a malformed input method ID or an input method not installed yet on the device, an error is returned and the value of this property will not be changed.

Input method ID: Android defines the input method ID as a string in the form "package_name/class_name", composed by the package name of the virtual keyboard application and the class name of the main input method service within the keyboard application.

E.g. Gboard input method ID is defined as "com.google.android.inputmethod.latin/com.android.inputmethod.latin.LatinIME", where:

  • com.google.android.inputmethod.latin: the package name is a unique identifier for the App, and in this case, it corresponds to the Latin IME (Input Method Editor) provided by Google. This package name is used by the Android system to recognize and manage the keyboard App.
  • com.android.inputmethod.latin.LatinIME: this is the fully qualified class name of the main input method service within the keyboard application. It specifies the particular class within the package that provides the actual functionality of the keyboard.

In summary, the first part identifies the App package, and the second part specifies the class within that package that implements the keyboard service.

Disclaimer: the fully qualified class name is used only if the namespace does not correspond to the package name. Otherwise, the short qualified class name is used instead. For example.:

  • Gboard uses the full class name, since package name and class namespace do not correspond: com.google.android.inputmethod.latin/com.android.inputmethod.latin.LatinIME
  • Labankey uses the short class name, since package name and class namespace corresponds: com.vng.inputmethod.labankey/.LatinIME

How to list the installed input methods and their IDs: use the command "adb shell ime list -a -s"

The class of the property is TextProperty.

[Android Documentation]

See Also