RadzenVirtualKeyboard Class

An on-screen virtual keyboard for touch HMI and kiosk scenarios. Attaches to the inputs rendered inside it and opens automatically when one of them gets focus. Key presses insert text in the focused input and raise the native input and change events so @bind-Value of the wrapped components updates as if typed on a physical keyboard.

Inheritance

Object

ComponentBase

RadzenComponent

RadzenVirtualKeyboard

Implements

IComponent

IHandleEvent

IHandleAfterRender

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenVirtualKeyboard : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender

Examples

<RadzenVirtualKeyboard>
    <RadzenTextBox @bind-Value=@name />
    <RadzenNumeric @bind-Value=@quantity />
</RadzenVirtualKeyboard>

Constructors

RadzenVirtualKeyboardLink to this section

An on-screen virtual keyboard for touch HMI and kiosk scenarios. Attaches to the inputs rendered inside it and opens automatically when one of them gets focus. Key presses insert text in the focused input and raise the native input and change events so @bind-Value of the wrapped components updates as if typed on a physical keyboard.

Declaration
public RadzenVirtualKeyboard()

Properties

AriaLabelLink to this section

Gets or sets the aria-label of the keyboard panel.

Declaration
public string AriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the keyboard panel.

BackspaceAriaLabelLink to this section

Gets or sets the aria-label of the backspace key.

Declaration
public string BackspaceAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the backspace key.

ChildContentLink to this section

Gets or sets the content containing the inputs the keyboard attaches to.

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the content containing the inputs the keyboard attaches to.

ClearAriaLabelLink to this section

Gets or sets the aria-label of the clear key.

Declaration
public string ClearAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the clear key.

CloseAriaLabelLink to this section

Gets or sets the aria-label of the close key.

Declaration
public string CloseAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the close key.

DecimalSeparatorLink to this section

Gets or sets the text inserted by the {decimal} key. The decimal separator of Culture is used by default.

Declaration
public string DecimalSeparator { get; set; }
Property Value
Type Description
stringGets or sets the text inserted by the {decimal} key. The decimal separator of Culture is used by default.

EnterAriaLabelLink to this section

Gets or sets the aria-label of the enter key.

Declaration
public string EnterAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the enter key.

LayoutLink to this section

Gets or sets a custom key layout which replaces the default one for the current Type. Use the Qwerty, Qwertz and Azerty presets for locale-aware layouts or String[]) to define your own keys.

Declaration
public VirtualKeyboardLayout Layout { get; set; }
Property Value
Type Description
VirtualKeyboardLayoutGets or sets a custom key layout which replaces the default one for the current Type. Use the Qwerty, Qwertz and Azerty presets for locale-aware layouts or String[]) to define your own keys.

PlacementLink to this section

Gets or sets where the keyboard is displayed. Set to Bottom by default.

Declaration
public VirtualKeyboardPlacement Placement { get; set; }
Property Value
Type Description
VirtualKeyboardPlacementGets or sets where the keyboard is displayed. Set to Bottom by default.

ShiftAriaLabelLink to this section

Gets or sets the aria-label of the shift key.

Declaration
public string ShiftAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the shift key.

SpaceAriaLabelLink to this section

Gets or sets the aria-label of the space key.

Declaration
public string SpaceAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the space key.

TabAriaLabelLink to this section

Gets or sets the aria-label of the tab key.

Declaration
public string TabAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the tab key.

TypeLink to this section

Gets or sets the set of keys displayed by the keyboard. Set to Alphanumeric by default.

Declaration
public VirtualKeyboardType Type { get; set; }
Property Value
Type Description
VirtualKeyboardTypeGets or sets the set of keys displayed by the keyboard. Set to Alphanumeric by default.

Methods

BuildRenderTreeLink to this section

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

DisposeLink to this section

Declaration
public override void Dispose()

GetComponentCssClassLink to this section

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

OnAfterRenderAsyncLink to this section

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
bool firstRender
Returns
Type Description
Task

SetParametersAsyncLink to this section

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Type Name Description
ParameterView parameters
Returns
Type Description
Task
An error has occurred. This app may no longer respond until reloaded. Reload 🗙