Class

RadVirtualKeyboardElement

Initializes a new instance of the RadVirtualKeyboardElement class with default settings and registers event listeners.

Declaration

public RadVirtualKeyboardElement()

Gets or sets the audio stream used for key press sounds. Returns the default sound if no custom stream is set.

Declaration

public Stream ClickSoundStream { get; set; }

Property Value

Gets or sets the culture used for keyboard layout and key text generation.

Declaration

public CultureInfo CurrentCulture { get; set; }

Property Value

Gets a value indicating whether the Alt modifier key is currently in active state.

Declaration

public bool IsAltActive { get; }

Property Value

Gets a value indicating whether the AltGr (right Alt) modifier key is currently in active state.

Declaration

public bool IsAltGrActive { get; }

Property Value

Gets a value indicating whether the CapsLock key is currently active system-wide.

Declaration

public static bool IsCapsLockOn { get; }

Property Value

Gets a value indicating whether the Control modifier key is currently in active state.

Declaration

public bool IsControlActive { get; }

Property Value

Gets a value indicating whether the NumLock key is currently in active state.

Declaration

public bool IsNumLockActive { get; }

Property Value

Implements IVirtualKeyboardKeyInputSender.IsNumLockActive

Gets a value indicating whether the NumLock key is currently active system-wide.

Declaration

public static bool IsNumLockOn { get; }

Property Value

Gets a value indicating whether the ScrollLock key is currently active system-wide.

Declaration

public static bool IsScrollLockOn { get; }

Property Value

Gets a value indicating whether the Shift modifier key is currently in active state.

Declaration

public bool IsShiftActive { get; }

Property Value

Implements IVirtualKeyboardKeyInputSender.IsShiftActive

Gets a value indicating whether the Windows modifier key is currently in active state.

Declaration

public bool IsWindowsKeyActive { get; }

Property Value

Gets the collection of objects that implement IKeyboardLayoutUpdatedListener and will be notified when keyboard layout or language changes.

Declaration

public static IList<IKeyboardLayoutUpdatedListener> KeyboardLayoutUpdatedListenersList { get; }

Property Value

Gets the timer that periodically checks for system language changes and notifies listeners when changes occur.

Declaration

public static Timer LanguageCheckTimer { get; }

Property Value

Gets or sets the keyboard layout type which determines the arrangement and availability of keys on the virtual keyboard.

Declaration

public KeyboardLayoutType LayoutType { get; set; }

Property Value

Gets or sets the main layout panel that hosts and arranges the keyboard layouts and key elements.

Declaration

public VirtualKeyboardLayoutPanel MainLayoutPanel { get; set; }

Property Value

Gets the collection of virtual key codes for currently active modifier keys.

Declaration

public List<int> ModifierKeys { get; }

Property Value

Gets or sets a value indicating whether the RadVirtualKeyboard should intercept system mouse clicks on its surface before they are processed by other application pop-ups, context menus, drop-downs, or any other elements that are automatically closed when you click outside of their surface. This prevents these UI elements from closing unexpectedly when users interact with the virtual keyboard, ensuring a seamless typing experience in touch-enabled scenarios.

Declaration

public static bool PreventPopupsAutoClose { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether the font size should be automatically scaled when the control size changes.

Declaration

public bool ScaleFontOnResize { get; set; }

Property Value

Implements IVirtualKeyboardKeyInputSender.ScaleFontOnResize

Gets or sets a value indicating whether the virtual keyboard will automatically synchronize with system language changes.

Declaration

public bool SynchronizeCultureWithSystem { get; set; }

Property Value

Gets the collection of objects that implement IUpdateKeysListener and will be notified when CapsLock, NumLock or ScrollLock state changes.

Declaration

public static IList<IUpdateKeysListener> UpdateKeysListenersList { get; }

Property Value

Gets or sets a value indicating whether a click sound should be played when keys are pressed.

Declaration

public bool UseClickSound { get; set; }

Property Value

Releases all managed resources used by the RadVirtualKeyboardElement and removes event listeners.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Returns a VirtualKeyboardLayoutPanel instance with predefined keyboard layout based on the specified layout type.

Declaration

protected virtual VirtualKeyboardLayoutPanel GetLayoutPanelByLayoutType(KeyboardLayoutType value)

Parameters

Returns

Extracts the appropriate text representation from a KeyInfo object based on current modifier key states.

Declaration

public string GetTextFromKeyInfo(KeyInfo keyInfo)

Parameters

Returns

Implements IVirtualKeyboardKeyInputSender.GetTextFromKeyInfo(KeyInfo)

Initializes member fields to their default values during element construction.

Declaration

protected override void InitializeFields()

Overrides LightVisualElement.InitializeFields()

Handles key press events from the system and updates lock key states accordingly.

Declaration

public void OnKeyPressed(Keys key)

Parameters

Implements IKeyPressedListener.OnKeyPressed(Keys)

Raises the KeyboardLayoutChanged event with the specified event arguments.

Declaration

protected virtual void OnKeyboardLayoutChanged(VirtualKeyboardLayoutChangedEventArgs e)

Parameters

Called when the element has been successfully loaded including all its children.

Declaration

protected override void OnLoaded()

Overrides LightVisualElement.OnLoaded()

Raises the KeySending event with the specified event arguments.

Declaration

protected virtual void OnVirtualKeySending(VirtualKeyboardKeySendingEventArgs e)

Parameters

Raises the KeySent event with the specified event arguments and plays the click sound if enabled.

Declaration

protected virtual void OnVirtualKeySent(VirtualKeyboardKeySentEventArgs e)

Parameters

Plays the configured click sound if UseClickSound is enabled.

Declaration

protected virtual void PlaySound()

Sends a key input using the specified Keys enumeration value to the focused application.

Declaration

public void Send(IKey sender, Keys key)

Parameters

Implements IVirtualKeyboardKeyInputSender.Send(IKey, Keys)

Sends a character input to the focused application.

Declaration

public void Send(IKey sender, char symbol)

Parameters

Implements IVirtualKeyboardKeyInputSender.Send(IKey, char)

Sends a key input using the specified virtual key code to the focused application.

Declaration

public void Send(IKey sender, int virtualKey)

Parameters

Implements IVirtualKeyboardKeyInputSender.Send(IKey, int)

Sends text input to the focused application.

Declaration

public void Send(IKey sender, string text)

Parameters

Implements IVirtualKeyboardKeyInputSender.Send(IKey, string)

Core implementation for sending key input with support for both virtual key codes and text.

Declaration

protected virtual void SendCore(IKey sender, KeySendContext context, int? virtualKey = null, string text = null)

Parameters

Handles keyboard layout changes from the system and updates the virtual keyboard accordingly.

Declaration

public void UpdateKeyboardLayout(CultureInfo culture)

Parameters

Implements IKeyboardLayoutUpdatedListener.UpdateKeyboardLayout(CultureInfo)

Updates the text and appearance of all keys in the virtual keyboard based on the current culture and modifier key states.

Declaration

public void UpdateKeys()

Implements IUpdateKeysListener.UpdateKeys()

Notifies all registered listeners when CapsLock, NumLock or ScrollLock state changes.

Declaration

public static void UpdateKeysListeners()

Updates the visual state of modifier and lock keys based on the current keyboard state.

Declaration

protected virtual void UpdateModifierKeys(IKey key)

Parameters

Occurs before a key is sent to the target application, allowing cancellation or modification of the key operation.

Declaration

public event VirtualKeyboardKeySendingEventHandler KeySending

Event Value

Occurs after a key has been successfully sent to the target application.

Declaration

public event VirtualKeyboardKeySentEventHandler KeySent

Event Value

Occurs when the keyboard layout or culture changes, providing information about the old and new cultures.

Declaration

public event VirtualKeyboardLayoutChangedEventHandler KeyboardLayoutChanged

Event Value