ClassRadVirtualKeyboardForm
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:
public class RadVirtualKeyboardForm : Component, IComponent, IDisposable, IExtenderProvider
Inheritance: objectMarshalByRefObjectComponentRadVirtualKeyboardForm
Implements:
Inherited Members
Constructors
RadVirtualKeyboardForm()
Initializes a new instance of the RadVirtualKeyboardForm component.
Declaration
public RadVirtualKeyboardForm()
RadVirtualKeyboardForm(IContainer)
Initializes a new instance of the RadVirtualKeyboardForm component.
Declaration
public RadVirtualKeyboardForm(IContainer container)
Parameters
container
The parent container.
Properties
KeyboardForm
Gets the VirtualKeyboardForm instance. Creates a new instance if one does not exist.
Declaration
[Browsable(false)]
public VirtualKeyboardForm KeyboardForm { get; }
Property Value
LayoutType
Gets or sets the keyboard layout type. Changing this value will automatically update the MainLayoutPanel property with a predefined layout configuration.
Declaration
public KeyboardLayoutType LayoutType { get; set; }
Property Value
MainLayoutPanel
Gets or sets the VirtualKeyboardLayoutPanel that hosts and arranges VirtualKeyboardLayoutPanel and VirtualKeyboardLayout objects within the virtual keyboard.
Declaration
[Browsable(false)]
public VirtualKeyboardLayoutPanel MainLayoutPanel { get; set; }
Property Value
OpenUnderAssociatedControl
Gets or sets a value indicating whether to automatically position the VirtualKeyboardForm beneath the associated control that receives focus.
Declaration
[Browsable(true)]
public bool OpenUnderAssociatedControl { get; set; }
Property Value
ScaleFontOnResize
Gets or sets a value indicating whether to automatically scale the font size when the KeyboardForm size changes.
SynchronizeCultureWithSystem
Gets or sets a value indicating whether the RadVirtualKeyboard will automatically track system language changes and update its layout accordingly.
Declaration
public bool SynchronizeCultureWithSystem { get; set; }
Property Value
ThemeName
Gets or sets the theme name applied to the VirtualKeyboardForm.
Declaration
[Browsable(true)]
public string ThemeName { get; set; }
Property Value
UseClickSound
Gets or sets a value indicating whether to play an audible click sound when a virtual keyboard key is pressed.
VirtualKeyboard
Gets the RadVirtualKeyboard control contained within the KeyboardForm.
Declaration
[Browsable(false)]
public RadVirtualKeyboard VirtualKeyboard { get; }
Property Value
Methods
AddAssociatedControl(Control)
Adds an associated control. When the associated control gains the focus the KeyboardForm will be shown.
Declaration
public void AddAssociatedControl(Control value)
Parameters
value
The control to associate with the virtual keyboard.
CreateVirtualKeyboardForm()
Creates a VirtualKeyboardForm.
Declaration
protected virtual VirtualKeyboardForm CreateVirtualKeyboardForm()
Returns
The created form.
GetAssociatedKeyboardType(Control)
Gets the AssociatedKeyboardType of a given control.
Declaration
public AssociatedKeyboardType GetAssociatedKeyboardType(Control control)
Parameters
control
The control.
Returns
The type of association.
RemoveAssociatedControl(Control)
Removes an associated control from the virtual keyboard.
Declaration
public void RemoveAssociatedControl(Control value)
Parameters
value
The control to remove from the virtual keyboard association.
SetAssociatedKeyboardType(Control, AssociatedKeyboardType)
Sets AssociatedKeyboardType to a given control.
Declaration
public void SetAssociatedKeyboardType(Control control, AssociatedKeyboardType value)
Parameters
control
The control.
value
The type of association.
Show()
Shows the KeyboardForm as a non-modal dialog box.
Declaration
public void Show()
UpdateKeyboardFormSizeAndLocation(Rectangle)
Updates the size and location of the KeyboardForm based on the screen bounds and associated control position.
Declaration
protected virtual void UpdateKeyboardFormSizeAndLocation(Rectangle associatedControlScreenBounds)
Parameters
associatedControlScreenBounds
The screen bounds of the associated control.