Class
RadVirtualKeyboardForm

Represents a toolbox component that provides virtual keyboard functionality by associating a VirtualKeyboardForm with any focusable control or displaying it as a standalone form for keyboard input.

Definition

Constructors

RadVirtualKeyboardForm()

Initializes a new instance of the RadVirtualKeyboardForm component.

Declaration

cs-api-definition
public RadVirtualKeyboardForm()

RadVirtualKeyboardForm(IContainer)

Initializes a new instance of the RadVirtualKeyboardForm component.

Declaration

cs-api-definition
public RadVirtualKeyboardForm(IContainer container)

Parameters

container

IContainer

The parent container.

Properties

KeyboardForm

Gets the VirtualKeyboardForm instance. Creates a new instance if one does not exist.

Declaration

cs-api-definition
[Browsable(false)]
public VirtualKeyboardForm KeyboardForm { get; }

Property Value

VirtualKeyboardForm

LayoutType

Gets or sets the keyboard layout type. Changing this value will automatically update the MainLayoutPanel property with a predefined layout configuration.

Declaration

cs-api-definition
public KeyboardLayoutType LayoutType { get; set; }

Property Value

KeyboardLayoutType

MainLayoutPanel

Gets or sets the VirtualKeyboardLayoutPanel that hosts and arranges VirtualKeyboardLayoutPanel and VirtualKeyboardLayout objects within the virtual keyboard.

Declaration

cs-api-definition
[Browsable(false)]
public VirtualKeyboardLayoutPanel MainLayoutPanel { get; set; }

Property Value

VirtualKeyboardLayoutPanel

OpenUnderAssociatedControl

Gets or sets a value indicating whether to automatically position the VirtualKeyboardForm beneath the associated control that receives focus.

Declaration

cs-api-definition
[Browsable(true)]
public bool OpenUnderAssociatedControl { get; set; }

Property Value

bool

ScaleFontOnResize

Gets or sets a value indicating whether to automatically scale the font size when the KeyboardForm size changes.

Declaration

cs-api-definition
public bool ScaleFontOnResize { get; set; }

Property Value

bool

SynchronizeCultureWithSystem

Gets or sets a value indicating whether the RadVirtualKeyboard will automatically track system language changes and update its layout accordingly.

Declaration

cs-api-definition
public bool SynchronizeCultureWithSystem { get; set; }

Property Value

bool

ThemeName

Gets or sets the theme name applied to the VirtualKeyboardForm.

Declaration

cs-api-definition
[Browsable(true)]
public string ThemeName { get; set; }

Property Value

string

UseClickSound

Gets or sets a value indicating whether to play an audible click sound when a virtual keyboard key is pressed.

Declaration

cs-api-definition
public bool UseClickSound { get; set; }

Property Value

bool

VirtualKeyboard

Gets the RadVirtualKeyboard control contained within the KeyboardForm.

Declaration

cs-api-definition
[Browsable(false)]
public RadVirtualKeyboard VirtualKeyboard { get; }

Property Value

RadVirtualKeyboard

Methods

AddAssociatedControl(Control)

Adds an associated control. When the associated control gains the focus the KeyboardForm will be shown.

Declaration

cs-api-definition
public void AddAssociatedControl(Control value)

Parameters

value

Control

The control to associate with the virtual keyboard.

CreateVirtualKeyboardForm()

Declaration

cs-api-definition
protected virtual VirtualKeyboardForm CreateVirtualKeyboardForm()

Returns

VirtualKeyboardForm

The created form.

GetAssociatedKeyboardType(Control)

Gets the AssociatedKeyboardType of a given control.

Declaration

cs-api-definition
public AssociatedKeyboardType GetAssociatedKeyboardType(Control control)

Parameters

control

Control

The control.

Returns

AssociatedKeyboardType

The type of association.

RemoveAssociatedControl(Control)

Removes an associated control from the virtual keyboard.

Declaration

cs-api-definition
public void RemoveAssociatedControl(Control value)

Parameters

value

Control

The control to remove from the virtual keyboard association.

SetAssociatedKeyboardType(Control, AssociatedKeyboardType)

Sets AssociatedKeyboardType to a given control.

Declaration

cs-api-definition
public void SetAssociatedKeyboardType(Control control, AssociatedKeyboardType value)

Parameters

control

Control

The control.

value

AssociatedKeyboardType

The type of association.

Show()

Shows the KeyboardForm as a non-modal dialog box.

Declaration

cs-api-definition
public void Show()

UpdateKeyboardFormSizeAndLocation(Rectangle)

Updates the size and location of the KeyboardForm based on the screen bounds and associated control position.

Declaration

cs-api-definition
protected virtual void UpdateKeyboardFormSizeAndLocation(Rectangle associatedControlScreenBounds)

Parameters

associatedControlScreenBounds

Rectangle

The screen bounds of the associated control.