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

RegularKeyViewModel

Class

Represents the class for virtual keyboard regular key view models.

Definition

Namespace:Telerik.Windows.Controls.VirtualKeyboard

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

public class RegularKeyViewModel : BaseKeyViewModel, INotifyPropertyChanged, IDisposable

Inheritance: objectViewModelBaseBaseKeyViewModelRegularKeyViewModel

Implements: IDisposableINotifyPropertyChanged

Inherited Members BaseKeyViewModel.GetModifiers()BaseKeyViewModel.KeyCommandBaseKeyViewModel.KeySoundPlayerBaseKeyViewModel.VirtualKeyBaseKeyViewModel.KeyTypeBaseKeyViewModel.KeyWidthBaseKeyViewModel.KeyHeightBaseKeyViewModel.ModifierKeysBaseKeyViewModel.DisplayTextViewModelBase.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

RegularKeyViewModel(int, double, double, bool, string)

Initializes a new instance of the RegularKeyViewModel class.

public RegularKeyViewModel(int virtualKey, double keyWidth, double keyHeight, bool showSecondaryText, string displayText = null)

Parameters:virtualKeyint

The virtual key.

keyWidthdouble

The width of the key.

keyHeightdouble

The height of the key.

showSecondaryTextbool

Indicates whether to show the secondary text.

displayTextstring

The display text of the key.

Properties

AltText

string

Gets or sets the display text shown when Alt key is pressed.

public string AltText { get; set; }

CapsLockText

string

Gets or sets the display text shown when CapsLock is toggled.

public string CapsLockText { get; set; }

LowerText

string

Gets or sets the display text shown when no modifier key is pressed.

public string LowerText { get; set; }

ShiftText

string

Gets or sets the display text shown when Shift key is pressed.

public string ShiftText { get; set; }

ShowSecondaryText

bool

Gets or sets the an additional text shown next to the primary display text.

public bool ShowSecondaryText { get; set; }

Methods

OnKeyCommandExecuted(object)

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

protected override void OnKeyCommandExecuted(object commandParameter)

Parameters:commandParameterobject

Overrides: BaseKeyViewModel.OnKeyCommandExecuted(object)

Update(IKeyUpdateContext)

Updates the state of the regular key view model based on the provided key update context.

public override void Update(IKeyUpdateContext context)

Parameters:contextIKeyUpdateContext

An instance of IKeyUpdateContext that supplies the necessary information for the update.

Overrides: BaseKeyViewModel.Update(IKeyUpdateContext)