Class RadVirtualKeyboardElement
The main element in the Rad
Inheritance
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll
Syntax
public class RadVirtualKeyboardElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IUpdateKeysListener, IKeyboardLayoutUpdatedListener, IKeyPressedListener, IVirtualKeyboardKeyInputSenderConstructors
RadVirtualKeyboardElement()
Initializes a new instance of the Rad
Declaration
public RadVirtualKeyboardElement()Properties
ClickSoundStream
Gets or sets the key press sound stream. Note that if you have not set the stream this property will return the default sound.
Declaration
public Stream ClickSoundStream { get; set; }Property Value
|
System.
|
CurrentCulture
Gets or sets current culture for the Rad
Declaration
public CultureInfo CurrentCulture { get; set; }Property Value
|
System.
|
IsAltActive
Gets a value indicating, whether the Alt key is in active state.
Declaration
public bool IsAltActive { get; }Property Value
|
System.
|
IsAltGrActive
Gets a value indicating, whether the Alt Gr(right alt) key is in active state.
Declaration
public bool IsAltGrActive { get; }Property Value
|
System.
|
IsCapsLockOn
Gets a value indicating whether the CapsLock key is on.
Declaration
public static bool IsCapsLockOn { get; }Property Value
|
System.
|
IsControlActive
Gets a value indicating, whether the Control key is in active state.
Declaration
public bool IsControlActive { get; }Property Value
|
System.
|
IsNumLockActive
Gets a value indicating, whether the NumLock key is in active state.
Declaration
public bool IsNumLockActive { get; }Property Value
|
System.
|
Implements
IsNumLockOn
Gets a value indicating whether the NumLock key is on.
Declaration
public static bool IsNumLockOn { get; }Property Value
|
System.
|
IsScrollLockOn
Gets a value indicating whether the ScrollLock key is on.
Declaration
public static bool IsScrollLockOn { get; }Property Value
|
System.
|
IsShiftActive
Gets a value indicating, whether the Shift key is in active state.
Declaration
public bool IsShiftActive { get; }Property Value
|
System.
|
Implements
IsWindowsKeyActive
Gets a value indicating, whether the Windows key is in active state.
Declaration
public bool IsWindowsKeyActive { get; }Property Value
|
System.
|
KeyboardLayoutUpdatedListenersList
Gets the IList with objects to be notified when keyboard layout/language/culture is changed.
Declaration
public static IList<IKeyboardLayoutUpdatedListener> KeyboardLayoutUpdatedListenersList { get; }Property Value
|
System.
|
LanguageCheckTimer
Gets the language change System.
Declaration
public static Timer LanguageCheckTimer { get; }Property Value
|
System.
|
LayoutType
Gets or sets the keyboard layout type. Changing the value will automatically set the Main
Declaration
public KeyboardLayoutType LayoutType { get; set; }Property Value
MainLayoutPanel
Gets or sets the Virtual
Declaration
public VirtualKeyboardLayoutPanel MainLayoutPanel { get; set; }Property Value
ModifierKeys
Gets the collection with currently active modifier keys.
Declaration
public List<int> ModifierKeys { get; }Property Value
|
System.
|
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.
|
Implements
SynchronizeCultureWithSystem
Gets or sets a value indicating whether the Rad
Declaration
public bool SynchronizeCultureWithSystem { get; set; }Property Value
|
System.
|
UpdateKeysListenersList
Gets the IList with objects to be notified when CapsLock, NumLock or ScrollLock are toggled.
Declaration
public static IList<IUpdateKeysListener> UpdateKeysListenersList { get; }Property Value
|
System.
|
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.
|
Methods
DisposeManagedResources()
Disposes all MANAGED resources - such as Bitmaps, GDI+ objects, etc.
Declaration
protected override void DisposeManagedResources()Overrides
DoKeyDown(KeyEventArgs)
The method is not relevant for this element.
Declaration
protected override void DoKeyDown(KeyEventArgs e)Parameters
|
System.
|
Overrides
DoKeyPress(KeyPressEventArgs)
The method is not relevant for this element.
Declaration
protected override void DoKeyPress(KeyPressEventArgs e)Parameters
|
System.
|
Overrides
DoKeyUp(KeyEventArgs)
The method is not relevant for this element.
Declaration
protected override void DoKeyUp(KeyEventArgs e)Parameters
|
System.
|
Overrides
GetLayoutPanelByLayoutType(KeyboardLayoutType)
Returns a Virtual
Declaration
protected virtual VirtualKeyboardLayoutPanel GetLayoutPanelByLayoutType(KeyboardLayoutType value)Parameters
|
Keyboard The keyboard layout type. |
Returns
|
Virtual The created Virtual |
GetTextFromKeyInfo(KeyInfo)
Extracts the text by given Key
Declaration
public string GetTextFromKeyInfo(KeyInfo keyInfo)Parameters
|
Key The info object. |
Returns
|
System. Returns the symbol/text. |
Implements
InitializeFields()
Initializes member fields to their default values. This method is called prior the CreateChildItems one and allows for initialization of members on which child elements depend.
Declaration
protected override void InitializeFields()Overrides
OnKeyboardLayoutChanged(VirtualKeyboardLayoutChangedEventArgs)
Forces the Keyboard
Declaration
protected virtual void OnKeyboardLayoutChanged(VirtualKeyboardLayoutChangedEventArgs e)Parameters
|
Virtual The Virtual |
OnKeyDown(KeyEventArgs)
The method is not relevant for this element.
Declaration
protected override void OnKeyDown(KeyEventArgs e)Parameters
|
System.
|
Overrides
OnKeyPress(KeyPressEventArgs)
The method is not relevant for this element.
Declaration
protected override void OnKeyPress(KeyPressEventArgs e)Parameters
|
System.
|
Overrides
OnKeyPressed(Keys)
Notifies all listeners when a key on the active window is pressed.
Declaration
public void OnKeyPressed(Keys key)Parameters
|
System. The pressed key. |
Implements
OnKeyUp(KeyEventArgs)
The method is not relevant for this element.
Declaration
protected override void OnKeyUp(KeyEventArgs e)Parameters
|
System.
|
Overrides
OnLoaded()
Called when the element has been successfully loaded. That includes loading of all its children as well.
Declaration
protected override void OnLoaded()Overrides
OnVirtualKeySending(VirtualKeyboardKeySendingEventArgs)
Forces the Key
Declaration
protected virtual void OnVirtualKeySending(VirtualKeyboardKeySendingEventArgs e)Parameters
|
Virtual The Virtual |
OnVirtualKeySent(VirtualKeyboardKeySentEventArgs)
Forces the Key
Declaration
protected virtual void OnVirtualKeySent(VirtualKeyboardKeySentEventArgs e)Parameters
|
Virtual The Virtual |
PlaySound()
RaiseKeyDown(KeyEventArgs)
The method is not relevant for this element.
Declaration
protected override void RaiseKeyDown(KeyEventArgs e)Parameters
|
System.
|
Overrides
RaiseKeyPress(KeyPressEventArgs)
The method is not relevant for this element.
Declaration
protected override void RaiseKeyPress(KeyPressEventArgs e)Parameters
|
System.
|
Overrides
RaiseKeyUp(KeyEventArgs)
The method is not relevant for this element.
Declaration
protected override void RaiseKeyUp(KeyEventArgs e)Parameters
|
System.
|
Overrides
Send(IKey, Char)
Sends a key by given char.
Declaration
public void Send(IKey sender, char symbol)Parameters
Implements
Send(IKey, Int32)
Sends a key by given virtual key.
Declaration
public void Send(IKey sender, int virtualKey)Parameters
Implements
Send(IKey, String)
Sends a key by given text/string.
Declaration
public void Send(IKey sender, string text)Parameters
Implements
Send(IKey, Keys)
Sends a key by given System.
Declaration
public void Send(IKey sender, Keys key)Parameters
|
IKey
sender
The sender IKey instance. |
|
System. The System. |
Implements
SendCore(IKey, KeySendContext, Nullable<Int32>, String)
Sends a message by given virtual key code or text/string.
Declaration
protected virtual void SendCore(IKey sender, KeySendContext context, int? virtualKey = default(int? ), string text = null)Parameters
|
IKey
sender
The sender IKey instance. |
|
Key The key context. |
|
System. The virtual key code. |
|
System. The text. |
UpdateKeyboardLayout(CultureInfo)
Raises the Keyboard
Declaration
public void UpdateKeyboardLayout(CultureInfo culture)Parameters
|
System. The new culture. |
Implements
UpdateKeys()
Updates all keys texts. Gets the all keys from all Virtual
Declaration
public void UpdateKeys()Implements
UpdateKeysListeners()
Notifies all listeners when CapsLock, NumLock or ScrollLock are toggled.
Declaration
public static void UpdateKeysListeners()UpdateModifierKeys(IKey)
Updates the state of modifier keys based on the current state of the Rad
Declaration
protected virtual void UpdateModifierKeys(IKey key)Parameters
|
IKey
key
The given key. |
Events
KeyboardLayoutChanged
An event that occurs when the culture(keyboard language) is changed.
Declaration
public event VirtualKeyboardLayoutChangedEventHandler KeyboardLayoutChangedEvent Type
KeyDown
The event is not relevant for this element.
Declaration
public event KeyEventHandler KeyDownEvent Type
|
System.
|
KeyPress
The event is not relevant for this element.
Declaration
public event KeyPressEventHandler KeyPressEvent Type
|
System.
|
KeySending
An event that occurs when a key is about to be sent. Cancellable.
Declaration
public event VirtualKeyboardKeySendingEventHandler KeySendingEvent Type
KeySent
An event that occurs when a key is sent.
Declaration
public event VirtualKeyboardKeySentEventHandler KeySentEvent Type
KeyUp
The event is not relevant for this element.
Declaration
public event KeyEventHandler KeyUpEvent Type
|
System.
|
Explicit Interface Implementations
IKeyPressedListener.OnMouseDown(Point)
Declaration
void IKeyPressedListener.OnMouseDown(Point mousePosition)Parameters
|
System.
|
Implements
IKeyPressedListener.OnMouseUp(Point)
Declaration
void IKeyPressedListener.OnMouseUp(Point mousePosition)Parameters
|
System.
|
Implements
IKeyPressedListener.ShouldInterceptMouseEvents(Point)
Declaration
bool IKeyPressedListener.ShouldInterceptMouseEvents(Point mousePosition)Parameters
|
System.
|
Returns
|
System.
|
