Skip to main content

VirtualKeyboardInputMethod Class

Definition​

Assembly:Avalonia.Controls.VirtualKeyboard
Package:Avalonia.Controls.VirtualKeyboard

This class represents a particular input method which is usually a keyboard layout possibly combined with an IME (Input Method Editor) engine for complex text input.

public class VirtualKeyboardInputMethod

Inheritance: object -> VirtualKeyboardInputMethod

Methods​

NameDescription
GetInputMethodByIdGets an input method by its stable identifier
GetInputMethodsForLanguageGets the list of input methods available for a given language tag
GetSupportedLanguagesGets the list of supported languages (IETF BCP 47 language tags)
ToStringNo summary available.

GetInputMethodById Method​

Gets an input method by its stable identifier

public Avalonia.Controls.VirtualKeyboardInputMethod GetInputMethodById(string id)

Parameters​

id string

Returns​

Avalonia.Controls.VirtualKeyboardInputMethod

GetInputMethodsForLanguage Method​

Gets the list of input methods available for a given language tag

public System.Collections.Generic.IReadOnlyList<Avalonia.Controls.VirtualKeyboardInputMethod> GetInputMethodsForLanguage(string languageTag)

Parameters​

languageTag string

Returns​

System.Collections.Generic.IReadOnlyList<Avalonia.Controls.VirtualKeyboardInputMethod>

GetSupportedLanguages Method​

Gets the list of supported languages (IETF BCP 47 language tags)

public System.Collections.Generic.IReadOnlyList<string> GetSupportedLanguages()

Returns​

System.Collections.Generic.IReadOnlyList<string>

ToString Method​

public string ToString()

Returns​

string

Properties​

NameDescription
DisplayNameAn English name for the input method, typically in "Language (Region)" format, like "English (United States)" or "Spanish (Latin America)"
IdStable identifier for the input method that can be used for persistent application configuration
LanguageTagIETF BCP 47 language tag, like "en", "en-US", "es-419"

DisplayName Property​

An English name for the input method, typically in "Language (Region)" format, like "English (United States)" or "Spanish (Latin America)"

public string DisplayName { get; set; }

Id Property​

Stable identifier for the input method that can be used for persistent application configuration

public string Id { get; set; }

LanguageTag Property​

IETF BCP 47 language tag, like "en", "en-US", "es-419"

public string LanguageTag { get; set; }