Class RadVirtualKeyboard

Represents a Keyboard control that allows the input from user.

Inheritance
System.Object
RadControl
RadVirtualKeyboard
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadVirtualKeyboard : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadVirtualKeyboard()

Initializes a new instance of the RadVirtualKeyboard class.

Declaration
public RadVirtualKeyboard()

Properties

DefaultSize

Gets the default size of the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Focusable

Gets or sets a value indicating whether the control is focusable.

Declaration
public override bool Focusable { get; set; }
Property Value
System.Boolean

Overrides

LayoutType

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

Declaration
public KeyboardLayoutType LayoutType { get; set; }
Property Value
KeyboardLayoutType

MainLayoutPanel

Gets or sets the VirtualKeyboardLayoutPanel, which is used to host and arrange VirtualKeyboardLayoutPanel and VirtualKeyboardLayout objects.

Declaration
public VirtualKeyboardLayoutPanel MainLayoutPanel { get; set; }
Property Value
VirtualKeyboardLayoutPanel

ScaleFontOnResize

Gets or sets a value indicating, whether to scale the font when control size in changed.

Declaration
public bool ScaleFontOnResize { get; set; }
Property Value
System.Boolean

SynchronizeCultureWithSystem

Gets or sets a value indicating whether the RadVirtualKeyboardElement will track with the system for language changes and will be updated automatically.

Declaration
public bool SynchronizeCultureWithSystem { get; set; }
Property Value
System.Boolean

Text

The property is not relevant for this control.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

UseClickSound

Gets or sets a value indicating whether to play sound when a key is pressed.

Declaration
public bool UseClickSound { get; set; }
Property Value
System.Boolean

VirtualKeyboardElement

Gets the RadVirtualKeyboardElement instance, which is the main element for RadVirtualKeyboard.

Declaration
public RadVirtualKeyboardElement VirtualKeyboardElement { get; }
Property Value
RadVirtualKeyboardElement

XmlSerializationInfo

Gets the serialization info for RadVirtualKeyboard used by Save/Load layout methods to persist the layout to/from XML. By default or when set to null the ComponentXmlSerializationInfo provided by GetDefaultXmlSerializationInfo() will be used.

Declaration
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }
Property Value
ComponentXmlSerializationInfo

Methods

CalculateDesiredSize()

Calculates the desired size of RadVirtualKeyboard, based on KeyDefaultSize, horizontal and vertical count of keys. Is also considers margins and padding of VirtualKeyboardElement.

Declaration
public virtual SizeF CalculateDesiredSize()
Returns
System.Drawing.SizeF

CanEditElementAtDesignTime(RadElement)

Determines whether an element is visible in the element hierarchy editor(Edit UI Elements dialog).

Declaration
protected override bool CanEditElementAtDesignTime(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

CreateKeyboardElement()

Creates a RadVirtualKeyboardElement, which is the main element for RadVirtualKeyboard.

Declaration
protected virtual RadVirtualKeyboardElement CreateKeyboardElement()
Returns
RadVirtualKeyboardElement

GetDefaultXmlSerializationInfo()

Gets the default serialization info for RadVirtualKeyboard used by Save/Load layout methods to persist the layout to/from XML.

Declaration
protected virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()
Returns
ComponentXmlSerializationInfo

The default serialization info.

LoadLayout(Stream)

Loads RadVirtualKeyboard's layout state from XML file, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(Stream stream)
Parameters
System.IO.Stream stream

The stream to read from.

LoadLayout(String)

Loads RadVirtualKeyboard's layout state from XML file, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(string fileName)
Parameters
System.String fileName

The file to read from.

LoadLayout(XmlReader)

Loads RadVirtualKeyboard's layout state from XML file, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(XmlReader xmlReader)
Parameters
System.Xml.XmlReader xmlReader

The XmlReader to read the XML from.

OnKeyDown(KeyEventArgs)

The method is not relevant for this control.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnKeyPress(KeyPressEventArgs)

The method is not relevant for this control.

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

Overrides

OnKeyUp(KeyEventArgs)

The method is not relevant for this control.

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnPreviewKeyDown(PreviewKeyDownEventArgs)

The method is not relevant for this control.

Declaration
protected override void OnPreviewKeyDown(PreviewKeyDownEventArgs e)
Parameters
System.Windows.Forms.PreviewKeyDownEventArgs e

Overrides

SaveLayout(Stream)

Stores RadVirtualKeyboard's layout state in XML format, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void SaveLayout(Stream stream)
Parameters
System.IO.Stream stream

The stream to write to.

SaveLayout(String)

Stores RadVirtualKeyboard's layout state in XML format, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void SaveLayout(string fileName)
Parameters
System.String fileName

The file to write to.

SaveLayout(XmlWriter)

Stores RadVirtualKeyboard's layout state in XML format, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void SaveLayout(XmlWriter xmlWriter)
Parameters
System.Xml.XmlWriter xmlWriter

XmlWriter to use by the built-in serializer

Events

KeyDown

The event is not relevant for this control.

Declaration
public event KeyEventHandler KeyDown
Event Type
System.Windows.Forms.KeyEventHandler

KeyPress

The event is not relevant for this control.

Declaration
public event KeyPressEventHandler KeyPress
Event Type
System.Windows.Forms.KeyPressEventHandler

KeySending

An event that occurs when a key is about to be sent. Cancellable.

Declaration
public event VirtualKeyboardKeySendingEventHandler KeySending
Event Type
VirtualKeyboardKeySendingEventHandler

KeySent

An event that occurs when a key is sent.

Declaration
public event VirtualKeyboardKeySentEventHandler KeySent
Event Type
VirtualKeyboardKeySentEventHandler

KeyUp

The event is not relevant for this control.

Declaration
public event KeyEventHandler KeyUp
Event Type
System.Windows.Forms.KeyEventHandler

PreviewKeyDown

The event is not relevant for this control.

Declaration
public event PreviewKeyDownEventHandler PreviewKeyDown
Event Type
System.Windows.Forms.PreviewKeyDownEventHandler

Extension Methods