New to Telerik UI for WinFormsStart a free 30-day trial

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

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadVirtualKeyboardForm : Component, IComponent, IDisposable, IExtenderProvider

Inheritance: objectMarshalByRefObjectComponentRadVirtualKeyboardForm

Implements: IComponentIDisposableIExtenderProvider

Constructors

Initializes a new instance of the RadVirtualKeyboardForm component.

C#
public RadVirtualKeyboardForm()

Initializes a new instance of the RadVirtualKeyboardForm component.

C#
public RadVirtualKeyboardForm(IContainer container)
Parameters:containerIContainer

The parent container.

Properties

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

C#
[Browsable(false)]
public VirtualKeyboardForm KeyboardForm { get; }

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

C#
public KeyboardLayoutType LayoutType { get; set; }

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

C#
[Browsable(false)]
public VirtualKeyboardLayoutPanel MainLayoutPanel { get; set; }

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

C#
[Browsable(true)]
public bool OpenUnderAssociatedControl { get; set; }

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

C#
public bool ScaleFontOnResize { get; set; }

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

C#
public bool SynchronizeCultureWithSystem { get; set; }

Gets or sets the theme name applied to the VirtualKeyboardForm.

C#
[Browsable(true)]
public string ThemeName { get; set; }

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

C#
public bool UseClickSound { get; set; }

Gets the RadVirtualKeyboard control contained within the KeyboardForm.

C#
[Browsable(false)]
public RadVirtualKeyboard VirtualKeyboard { get; }

Methods

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

C#
public void AddAssociatedControl(Control value)
Parameters:valueControl

The control to associate with the virtual keyboard.

C#
protected virtual VirtualKeyboardForm CreateVirtualKeyboardForm()
Returns:

VirtualKeyboardForm

The created form.

Gets the AssociatedKeyboardType of a given control.

C#
public AssociatedKeyboardType GetAssociatedKeyboardType(Control control)
Parameters:controlControl

The control.

Returns:

AssociatedKeyboardType

The type of association.

Removes an associated control from the virtual keyboard.

C#
public void RemoveAssociatedControl(Control value)
Parameters:valueControl

The control to remove from the virtual keyboard association.

Sets AssociatedKeyboardType to a given control.

C#
public void SetAssociatedKeyboardType(Control control, AssociatedKeyboardType value)
Parameters:controlControl

The control.

valueAssociatedKeyboardType

The type of association.

Shows the KeyboardForm as a non-modal dialog box.

C#
public void Show()

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

C#
protected virtual void UpdateKeyboardFormSizeAndLocation(Rectangle associatedControlScreenBounds)
Parameters:associatedControlScreenBoundsRectangle

The screen bounds of the associated control.