New to Telerik UI for WPF? Start a free 30-day trial

BaseKeyViewModel

Class

Represents the base class for virtual keyboard key view models.

Definition

Namespace:Telerik.Windows.Controls.VirtualKeyboard

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

public abstract class BaseKeyViewModel : ViewModelBase, INotifyPropertyChanged, IDisposable

Inheritance: objectViewModelBaseBaseKeyViewModel

Derived Classes: LockKeyViewModelModifierKeyViewModelNumpadKeyViewModelRegularKeyViewModelSpecialKeyViewModel

Implements: IDisposableINotifyPropertyChanged

Inherited Members ViewModelBase.VerifyPropertyName(string)ViewModelBase.UpdateValue<T>(ref T, T, string)ViewModelBase.InvokeOnUIThread(Action)ViewModelBase.Dispose()ViewModelBase.RaisePropertyChanged(string)ViewModelBase.OnPropertyChanged(string)ViewModelBase.OnPropertyChanged<T>(Expression<Func<T>>)ViewModelBase.Dispose(bool)ViewModelBase.PropertyChanged...

Constructors

BaseKeyViewModel(int, KeyType, double, double)

Initializes a new instance of the BaseKeyViewModel class.

protected BaseKeyViewModel(int virtualKey, KeyType keyType, double keyWidth, double keyHeight)

Parameters:virtualKeyint

The virtual key.

keyTypeKeyType

The type of the key.

keyWidthdouble

The width of the key.

keyHeightdouble

The height of the key.

Properties

DisplayText

string

Gets or sets the text to be displayed for the key.

public string DisplayText { get; set; }

KeyCommand

ICommand

Gets or sets the command to be executed hen the key is pressed.

public ICommand KeyCommand { get; set; }

KeyHeight

double

Gets the height of the key.

public double KeyHeight { get; }

KeySoundPlayer

IKeySoundPlayer

Gets the sound player that will be called to produce a sound when this key is pressed.

public IKeySoundPlayer KeySoundPlayer { get; }

KeyType

Gets the type of the key.

public KeyType KeyType { get; }

KeyWidth

double

Gets the width of the key.

public double KeyWidth { get; }

ModifierKeys

Gets the state of the modifier keys from the last update.

public ModifierKeys ModifierKeys { get; }

VirtualKey

int

Gets the virtual key of the key.

public int VirtualKey { get; }

Methods

GetModifiers()

ReadOnlyCollection<int>

Gets the state of the modifier keys (Shift, Ctrl...).

protected ReadOnlyCollection<int> GetModifiers()

Returns:

ReadOnlyCollection<int>

OnKeyCommandExecuted(object)

The method called by the default command assigned to the key.

protected abstract void OnKeyCommandExecuted(object commandParameter)

Parameters:commandParameterobject

Update(IKeyUpdateContext)

Called when the state of the keyboard changes.

public virtual void Update(IKeyUpdateContext context)

Parameters:contextIKeyUpdateContext